[
][
C:
/
Program Files (x86)
/
AWS SDK for .NET
/
past-releases
/
Version-2
/
Net45
/]
Upload
Terminal
File Manager
Server Info
Current File :
C:/Program Files (x86)/AWS SDK for .NET/past-releases/Version-2/Net45/AWSSDK.xml
<?xml version="1.0"?> <doc> <assembly> <name>AWSSDK</name> </assembly> <members> <member name="T:Amazon.DynamoDBv2.DataModel.S3Link"> <summary> S3Link is an object that provides a connection to an S3 resource that can be stored in a DynamoDB field through DynamoDBContext </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.UploadFromAsync(System.String,System.Threading.CancellationToken)"> <summary> Uploads the specified file and stores it in the specified bucket with the provided key from construction. </summary> <param name="sourcePath">Path of the file to be uploaded.</param> <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>An asynchronous task of the request</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.DownloadToAsync(System.String,System.Threading.CancellationToken)"> <summary> Downloads the file from the S3Link's specified bucket and key then saves it in the given path. Creates directories and the file if they do not already exist. </summary> <param name="downloadPath">Path to save the file.</param> <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>An asynchronous task of the request</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.Create(Amazon.DynamoDBv2.DataModel.DynamoDBContext,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Creates an S3Link that can be used to managed an S3 connection </summary> <param name="context">The context that is handling the S3Link</param> <param name="bucket">The bucket the S3Link should manage</param> <param name="key">The key that S3Link should store and download from</param> <param name="region">The region of the S3 resource</param> <returns>A new S3Link object that can upload and download to the target bucket</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.MakeS3ObjectPublic(System.Boolean)"> <summary> If enable is set to true the object will have its permission set to PublicRead otherwise the permissions will be set to Private. </summary> <param name="enable">If true the object will have its permission set to PublicRead otherwise the permissions will be set to Private.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.SetACL(Amazon.S3.S3CannedACL)"> <summary> Sets the S3 Object's ACL </summary> <param name="cannedACL">CannedACL assigned to object</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.SetACL(Amazon.S3.Model.S3AccessControlList)"> <summary> Sets the S3 Objects's ACL </summary> <param name="acl">ACL assigned to the S3 object</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.GetPreSignedURL(System.DateTime)"> <summary> Provides a URL for accessing the S3 object managed by S3Link </summary> <param name="expiration">The time the link should become invalid</param> <returns>A URL directing to the S3 object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.UploadFrom(System.String)"> <summary> Uploads the specified file and stores it in the specified bucket with the provided key from construction. </summary> <param name="sourcePath">Path of the file to be uploaded.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.DownloadTo(System.String)"> <summary> Downloads the file from the S3Link's specified bucket and key then saves it in the given path. Creates directories and the file if they do not already exist. </summary> <param name="downloadPath">Path to save the file.</param> </member> <member name="P:Amazon.DynamoDBv2.DataModel.S3Link.Key"> <summary> The Key that S3Link stores and downloads a resource to and from </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.S3Link.BucketName"> <summary> The name of the target Bucket for the managed resource </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.S3Link.Region"> <summary> The region the S3 resource is in </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.S3Link.RegionAsEndpoint"> <summary> Looks up RegionEndpoint based on region as a string </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.IPropertyConverter"> <summary> Interface for converting arbitrary objects to DynamoDB-supported object types. Implementing type must be public, instantiable, and should have a zero-parameter constructor. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IPropertyConverter.ToEntry(System.Object)"> <summary> Convert object to DynamoDBEntry </summary> <param name="value">Object to be deserialized</param> <returns>Object deserialized as DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IPropertyConverter.FromEntry(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)"> <summary> Convert DynamoDBEntry to the specified object </summary> <param name="entry">DynamoDBEntry to be serialized</param> <returns>Serialized object</returns> </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"></typeparam> <returns></returns> </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="T:Amazon.Runtime.Internal.ErrorHandler"> <summary> This handler processes exceptions thrown from the HTTP handler and unmarshalls error responses. </summary> </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="T:Amazon.Runtime.IPipelineHandler"> <summary> Interface for a handler in a pipeline. </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="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.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="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="F: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="P:Amazon.Runtime.Internal.ErrorHandler.ExceptionHandlers"> <summary> Default set of exception handlers. </summary> </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.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="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="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.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="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="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="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="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="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="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="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="P:Amazon.Runtime.Internal.HttpHandler`1.CallbackSender"> <summary> The sender parameter used in any events raised by this handler. </summary> </member> <member name="T:Amazon.Runtime.Internal.HttpWebRequestFactory"> <summary> The request factory for System.Net.HttpWebRequest. </summary> </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="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="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="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="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.Internal.HttpRequest.#ctor(System.Uri)"> <summary> Constructor for HttpRequest. </summary> <param name="requestUri">The request URI.</param> </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="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="T:Amazon.Runtime.Internal.DefaultRetryPolicy"> <summary> The default implementation of the retry policy. </summary> </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="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="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.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="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="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="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="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.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.AutoScaling.AmazonAutoScalingClient"> <summary> Implementation for accessing AutoScaling Auto Scaling <para> Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service in conjunction with the Amazon CloudWatch and Elastic Load Balancing services. </para> </summary> </member> <member name="T:Amazon.AutoScaling.IAmazonAutoScaling"> <summary> Interface for accessing AutoScaling Auto Scaling <para> Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service in conjunction with the Amazon CloudWatch and Elastic Load Balancing services. </para> </summary> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.AttachInstances(Amazon.AutoScaling.Model.AttachInstancesRequest)"> <summary> Attaches one or more EC2 instances to the specified Auto Scaling group. <para> When you attach instances, Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-instance-asg.html">Attach EC2 Instances to Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachInstances service method.</param> <returns>The response from the AttachInstances service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.AttachInstancesAsync(Amazon.AutoScaling.Model.AttachInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.AttachLoadBalancers(Amazon.AutoScaling.Model.AttachLoadBalancersRequest)"> <summary> Attaches one or more load balancers to the specified Auto Scaling group. <para> To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use <a>DetachLoadBalancers</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-load-balancer-asg.html">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachLoadBalancers service method.</param> <returns>The response from the AttachLoadBalancers service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.AttachLoadBalancersAsync(Amazon.AutoScaling.Model.AttachLoadBalancersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachLoadBalancers operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachLoadBalancers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.CompleteLifecycleAction(Amazon.AutoScaling.Model.CompleteLifecycleActionRequest)"> <summary> Completes the lifecycle action for the specified token or instance with the specified result. <para> This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: </para> <ol> <li>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</li> <li>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</li> <li>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</li> <li>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</li> <li><b>If you finish before the timeout period ends, complete the lifecycle action.</b></li> </ol> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CompleteLifecycleAction service method.</param> <returns>The response from the CompleteLifecycleAction service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.CompleteLifecycleActionAsync(Amazon.AutoScaling.Model.CompleteLifecycleActionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CompleteLifecycleAction operation. </summary> <param name="request">Container for the necessary parameters to execute the CompleteLifecycleAction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.CreateAutoScalingGroup(Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest)"> <summary> Creates an Auto Scaling group with the specified name and attributes. <para> If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroup.html">Auto Scaling Groups</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateAutoScalingGroup service method.</param> <returns>The response from the CreateAutoScalingGroup service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.AlreadyExistsException"> You already have an Auto Scaling group or launch configuration with this name. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.CreateAutoScalingGroupAsync(Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAutoScalingGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAutoScalingGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.CreateLaunchConfiguration(Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest)"> <summary> Creates a launch configuration. <para> If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/LaunchConfiguration.html">Launch Configurations</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLaunchConfiguration service method.</param> <returns>The response from the CreateLaunchConfiguration service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.AlreadyExistsException"> You already have an Auto Scaling group or launch configuration with this name. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.CreateLaunchConfigurationAsync(Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLaunchConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLaunchConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.CreateOrUpdateTags(Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest)"> <summary> Creates or updates tags for the specified Auto Scaling group. <para> When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateOrUpdateTags service method.</param> <returns>The response from the CreateOrUpdateTags service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.AlreadyExistsException"> You already have an Auto Scaling group or launch configuration with this name. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.CreateOrUpdateTagsAsync(Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateOrUpdateTags operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateOrUpdateTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DeleteAutoScalingGroup(Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest)"> <summary> Deletes the specified Auto Scaling group. <para> If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. </para> <para> If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action. </para> <para> To remove instances from the Auto Scaling group before deleting it, call <a>DetachInstances</a> with the list of instances and the option to decrement the desired capacity so that Auto Scaling does not launch replacement instances. </para> <para> To terminate all instances before deleting the Auto Scaling group, call <a>UpdateAutoScalingGroup</a> and set the minimum size and desired capacity of the Auto Scaling group to zero. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAutoScalingGroup service method.</param> <returns>The response from the DeleteAutoScalingGroup service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceInUseException"> The Auto Scaling group or launch configuration can't be deleted because it is in use. </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DeleteAutoScalingGroupAsync(Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAutoScalingGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAutoScalingGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DeleteLaunchConfiguration(Amazon.AutoScaling.Model.DeleteLaunchConfigurationRequest)"> <summary> Deletes the specified launch configuration. <para> The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLaunchConfiguration service method.</param> <returns>The response from the DeleteLaunchConfiguration service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceInUseException"> The Auto Scaling group or launch configuration can't be deleted because it is in use. </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DeleteLaunchConfigurationAsync(Amazon.AutoScaling.Model.DeleteLaunchConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLaunchConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLaunchConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DeleteLifecycleHook(Amazon.AutoScaling.Model.DeleteLifecycleHookRequest)"> <summary> Deletes the specified lifecycle hook. <para> If there are any outstanding lifecycle actions, they are completed first (<code>ABANDON</code> for launching instances, <code>CONTINUE</code> for terminating instances). </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLifecycleHook service method.</param> <returns>The response from the DeleteLifecycleHook service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DeleteLifecycleHookAsync(Amazon.AutoScaling.Model.DeleteLifecycleHookRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLifecycleHook operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLifecycleHook operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DeleteNotificationConfiguration(Amazon.AutoScaling.Model.DeleteNotificationConfigurationRequest)"> <summary> Deletes the specified notification. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNotificationConfiguration service method.</param> <returns>The response from the DeleteNotificationConfiguration service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DeleteNotificationConfigurationAsync(Amazon.AutoScaling.Model.DeleteNotificationConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteNotificationConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNotificationConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DeletePolicy(Amazon.AutoScaling.Model.DeletePolicyRequest)"> <summary> Deletes the specified Auto Scaling policy. <para> Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeletePolicy service method.</param> <returns>The response from the DeletePolicy service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DeletePolicyAsync(Amazon.AutoScaling.Model.DeletePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DeleteScheduledAction(Amazon.AutoScaling.Model.DeleteScheduledActionRequest)"> <summary> Deletes the specified scheduled action. </summary> <param name="request">Container for the necessary parameters to execute the DeleteScheduledAction service method.</param> <returns>The response from the DeleteScheduledAction service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DeleteScheduledActionAsync(Amazon.AutoScaling.Model.DeleteScheduledActionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteScheduledAction operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteScheduledAction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DeleteTags(Amazon.AutoScaling.Model.DeleteTagsRequest)"> <summary> Deletes the specified tags. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags service method.</param> <returns>The response from the DeleteTags service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DeleteTagsAsync(Amazon.AutoScaling.Model.DeleteTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAccountLimits"> <summary> Describes the current Auto Scaling resource limits for your AWS account. <para> For information about requesting an increase in these limits, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> <returns>The response from the DescribeAccountLimits service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAccountLimits(Amazon.AutoScaling.Model.DescribeAccountLimitsRequest)"> <summary> Describes the current Auto Scaling resource limits for your AWS account. <para> For information about requesting an increase in these limits, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountLimits service method.</param> <returns>The response from the DescribeAccountLimits service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAccountLimitsAsync(Amazon.AutoScaling.Model.DescribeAccountLimitsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAccountLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountLimits operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAdjustmentTypes"> <summary> Describes the policy adjustment types for use with <a>PutScalingPolicy</a>. </summary> <returns>The response from the DescribeAdjustmentTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAdjustmentTypes(Amazon.AutoScaling.Model.DescribeAdjustmentTypesRequest)"> <summary> Describes the policy adjustment types for use with <a>PutScalingPolicy</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAdjustmentTypes service method.</param> <returns>The response from the DescribeAdjustmentTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAdjustmentTypesAsync(Amazon.AutoScaling.Model.DescribeAdjustmentTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAdjustmentTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAdjustmentTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAutoScalingGroups"> <summary> Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups. </summary> <returns>The response from the DescribeAutoScalingGroups service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAutoScalingGroups(Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest)"> <summary> Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingGroups service method.</param> <returns>The response from the DescribeAutoScalingGroups service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAutoScalingGroupsAsync(Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAutoScalingInstances"> <summary> Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances. </summary> <returns>The response from the DescribeAutoScalingInstances service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAutoScalingInstances(Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest)"> <summary> Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingInstances service method.</param> <returns>The response from the DescribeAutoScalingInstances service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAutoScalingInstancesAsync(Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAutoScalingNotificationTypes"> <summary> Describes the notification types that are supported by Auto Scaling. </summary> <returns>The response from the DescribeAutoScalingNotificationTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAutoScalingNotificationTypes(Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesRequest)"> <summary> Describes the notification types that are supported by Auto Scaling. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingNotificationTypes service method.</param> <returns>The response from the DescribeAutoScalingNotificationTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAutoScalingNotificationTypesAsync(Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingNotificationTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingNotificationTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeLaunchConfigurations"> <summary> Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations. </summary> <returns>The response from the DescribeLaunchConfigurations service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeLaunchConfigurations(Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest)"> <summary> Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLaunchConfigurations service method.</param> <returns>The response from the DescribeLaunchConfigurations service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeLaunchConfigurationsAsync(Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLaunchConfigurations operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLaunchConfigurations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeLifecycleHooks(Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest)"> <summary> Describes the lifecycle hooks for the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLifecycleHooks service method.</param> <returns>The response from the DescribeLifecycleHooks service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeLifecycleHooksAsync(Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLifecycleHooks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLifecycleHooks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeLifecycleHookTypes(Amazon.AutoScaling.Model.DescribeLifecycleHookTypesRequest)"> <summary> Describes the available types of lifecycle hooks. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLifecycleHookTypes service method.</param> <returns>The response from the DescribeLifecycleHookTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeLifecycleHookTypesAsync(Amazon.AutoScaling.Model.DescribeLifecycleHookTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLifecycleHookTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLifecycleHookTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeLoadBalancers(Amazon.AutoScaling.Model.DescribeLoadBalancersRequest)"> <summary> Describes the load balancers for the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancers service method.</param> <returns>The response from the DescribeLoadBalancers service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeLoadBalancersAsync(Amazon.AutoScaling.Model.DescribeLoadBalancersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancers operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeMetricCollectionTypes"> <summary> Describes the available CloudWatch metrics for Auto Scaling. <para> Note that the <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request this metric when calling <a>EnableMetricsCollection</a>. </para> </summary> <returns>The response from the DescribeMetricCollectionTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeMetricCollectionTypes(Amazon.AutoScaling.Model.DescribeMetricCollectionTypesRequest)"> <summary> Describes the available CloudWatch metrics for Auto Scaling. <para> Note that the <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request this metric when calling <a>EnableMetricsCollection</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeMetricCollectionTypes service method.</param> <returns>The response from the DescribeMetricCollectionTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeMetricCollectionTypesAsync(Amazon.AutoScaling.Model.DescribeMetricCollectionTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeMetricCollectionTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMetricCollectionTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeNotificationConfigurations"> <summary> Describes the notification actions associated with the specified Auto Scaling group. </summary> <returns>The response from the DescribeNotificationConfigurations service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeNotificationConfigurations(Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest)"> <summary> Describes the notification actions associated with the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNotificationConfigurations service method.</param> <returns>The response from the DescribeNotificationConfigurations service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeNotificationConfigurationsAsync(Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeNotificationConfigurations operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNotificationConfigurations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribePolicies"> <summary> Describes the policies for the specified Auto Scaling group. </summary> <returns>The response from the DescribePolicies service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribePolicies(Amazon.AutoScaling.Model.DescribePoliciesRequest)"> <summary> Describes the policies for the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DescribePolicies service method.</param> <returns>The response from the DescribePolicies service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribePoliciesAsync(Amazon.AutoScaling.Model.DescribePoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribePolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeScalingActivities"> <summary> Describes one or more scaling activities for the specified Auto Scaling group. If you omit the <code>ActivityIds</code>, the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list. </summary> <returns>The response from the DescribeScalingActivities service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeScalingActivities(Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest)"> <summary> Describes one or more scaling activities for the specified Auto Scaling group. If you omit the <code>ActivityIds</code>, the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingActivities service method.</param> <returns>The response from the DescribeScalingActivities service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeScalingActivitiesAsync(Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeScalingActivities operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingActivities operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeScalingProcessTypes"> <summary> Describes the scaling process types for use with <a>ResumeProcesses</a> and <a>SuspendProcesses</a>. </summary> <returns>The response from the DescribeScalingProcessTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeScalingProcessTypes(Amazon.AutoScaling.Model.DescribeScalingProcessTypesRequest)"> <summary> Describes the scaling process types for use with <a>ResumeProcesses</a> and <a>SuspendProcesses</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingProcessTypes service method.</param> <returns>The response from the DescribeScalingProcessTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeScalingProcessTypesAsync(Amazon.AutoScaling.Model.DescribeScalingProcessTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeScalingProcessTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingProcessTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeScheduledActions"> <summary> Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use <a>DescribeScalingActivities</a>. </summary> <returns>The response from the DescribeScheduledActions service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeScheduledActions(Amazon.AutoScaling.Model.DescribeScheduledActionsRequest)"> <summary> Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use <a>DescribeScalingActivities</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScheduledActions service method.</param> <returns>The response from the DescribeScheduledActions service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeScheduledActionsAsync(Amazon.AutoScaling.Model.DescribeScheduledActionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeScheduledActions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScheduledActions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeTags"> <summary> Describes the specified tags. <para> You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. </para> <para> You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned. </para> </summary> <returns>The response from the DescribeTags service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeTags(Amazon.AutoScaling.Model.DescribeTagsRequest)"> <summary> Describes the specified tags. <para> You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. </para> <para> You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags service method.</param> <returns>The response from the DescribeTags service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeTagsAsync(Amazon.AutoScaling.Model.DescribeTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeTerminationPolicyTypes"> <summary> Describes the termination policies supported by Auto Scaling. </summary> <returns>The response from the DescribeTerminationPolicyTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeTerminationPolicyTypes(Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesRequest)"> <summary> Describes the termination policies supported by Auto Scaling. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTerminationPolicyTypes service method.</param> <returns>The response from the DescribeTerminationPolicyTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeTerminationPolicyTypesAsync(Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTerminationPolicyTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTerminationPolicyTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DetachInstances(Amazon.AutoScaling.Model.DetachInstancesRequest)"> <summary> Removes one or more instances from the specified Auto Scaling group. <para> After the instances are detached, you can manage them independently from the rest of the Auto Scaling group. </para> <para> If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/detach-instance-asg.html">Detach EC2 Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachInstances service method.</param> <returns>The response from the DetachInstances service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DetachInstancesAsync(Amazon.AutoScaling.Model.DetachInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DetachLoadBalancers(Amazon.AutoScaling.Model.DetachLoadBalancersRequest)"> <summary> Removes one or more load balancers from the specified Auto Scaling group. <para> When you detach a load balancer, it enters the <code>Removing</code> state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using <a>DescribeLoadBalancers</a>. Note that the instances remain running. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachLoadBalancers service method.</param> <returns>The response from the DetachLoadBalancers service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DetachLoadBalancersAsync(Amazon.AutoScaling.Model.DetachLoadBalancersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachLoadBalancers operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachLoadBalancers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DisableMetricsCollection(Amazon.AutoScaling.Model.DisableMetricsCollectionRequest)"> <summary> Disables monitoring of the specified metrics for the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DisableMetricsCollection service method.</param> <returns>The response from the DisableMetricsCollection service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DisableMetricsCollectionAsync(Amazon.AutoScaling.Model.DisableMetricsCollectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableMetricsCollection operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableMetricsCollection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.EnableMetricsCollection(Amazon.AutoScaling.Model.EnableMetricsCollectionRequest)"> <summary> Enables monitoring of the specified metrics for the specified Auto Scaling group. <para> You can only enable metrics collection if <code>InstanceMonitoring</code> in the launch configuration for the group is set to <code>True</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the EnableMetricsCollection service method.</param> <returns>The response from the EnableMetricsCollection service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.EnableMetricsCollectionAsync(Amazon.AutoScaling.Model.EnableMetricsCollectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableMetricsCollection operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableMetricsCollection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.EnterStandby(Amazon.AutoScaling.Model.EnterStandbyRequest)"> <summary> Moves the specified instances into <code>Standby</code> mode. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the EnterStandby service method.</param> <returns>The response from the EnterStandby service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.EnterStandbyAsync(Amazon.AutoScaling.Model.EnterStandbyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnterStandby operation. </summary> <param name="request">Container for the necessary parameters to execute the EnterStandby operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.ExecutePolicy(Amazon.AutoScaling.Model.ExecutePolicyRequest)"> <summary> Executes the specified policy. </summary> <param name="request">Container for the necessary parameters to execute the ExecutePolicy service method.</param> <returns>The response from the ExecutePolicy service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.ExecutePolicyAsync(Amazon.AutoScaling.Model.ExecutePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ExecutePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the ExecutePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.ExitStandby(Amazon.AutoScaling.Model.ExitStandbyRequest)"> <summary> Moves the specified instances out of <code>Standby</code> mode. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ExitStandby service method.</param> <returns>The response from the ExitStandby service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.ExitStandbyAsync(Amazon.AutoScaling.Model.ExitStandbyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ExitStandby operation. </summary> <param name="request">Container for the necessary parameters to execute the ExitStandby operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.PutLifecycleHook(Amazon.AutoScaling.Model.PutLifecycleHookRequest)"> <summary> Creates or updates a lifecycle hook for the specified Auto Scaling Group. <para> A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates. </para> <para> This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: </para> <ol> <li>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</li> <li>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</li> <li><b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b></li> <li>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</li> <li>If you finish before the timeout period ends, complete the lifecycle action.</li> </ol> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> <para> If you exceed your maximum limit of lifecycle hooks, which by default is 50 per region, the call fails. For information about updating this limit, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutLifecycleHook service method.</param> <returns>The response from the PutLifecycleHook service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.PutLifecycleHookAsync(Amazon.AutoScaling.Model.PutLifecycleHookRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutLifecycleHook operation. </summary> <param name="request">Container for the necessary parameters to execute the PutLifecycleHook operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.PutNotificationConfiguration(Amazon.AutoScaling.Model.PutNotificationConfigurationRequest)"> <summary> Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to this topic can have messages for events delivered to an endpoint such as a web server or email address. <para> For more information see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASGettingNotifications.html">Getting Notifications When Your Auto Scaling Group Changes</a> in the <i>Auto Scaling Developer Guide</i>. </para> <para> This configuration overwrites an existing configuration. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutNotificationConfiguration service method.</param> <returns>The response from the PutNotificationConfiguration service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.PutNotificationConfigurationAsync(Amazon.AutoScaling.Model.PutNotificationConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutNotificationConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the PutNotificationConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.PutScalingPolicy(Amazon.AutoScaling.Model.PutScalingPolicyRequest)"> <summary> Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request. <para> If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutScalingPolicy service method.</param> <returns>The response from the PutScalingPolicy service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.PutScalingPolicyAsync(Amazon.AutoScaling.Model.PutScalingPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutScalingPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutScalingPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.PutScheduledUpdateGroupAction(Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest)"> <summary> Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/schedule_time.html">Scheduled Scaling</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutScheduledUpdateGroupAction service method.</param> <returns>The response from the PutScheduledUpdateGroupAction service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.AlreadyExistsException"> You already have an Auto Scaling group or launch configuration with this name. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.PutScheduledUpdateGroupActionAsync(Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutScheduledUpdateGroupAction operation. </summary> <param name="request">Container for the necessary parameters to execute the PutScheduledUpdateGroupAction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.RecordLifecycleActionHeartbeat(Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest)"> <summary> Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using <a>PutLifecycleHook</a>. <para> This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: </para> <ol> <li>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</li> <li>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</li> <li>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</li> <li><b>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</b></li> <li>If you finish before the timeout period ends, complete the lifecycle action.</li> </ol> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RecordLifecycleActionHeartbeat service method.</param> <returns>The response from the RecordLifecycleActionHeartbeat service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.RecordLifecycleActionHeartbeatAsync(Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RecordLifecycleActionHeartbeat operation. </summary> <param name="request">Container for the necessary parameters to execute the RecordLifecycleActionHeartbeat operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.ResumeProcesses(Amazon.AutoScaling.Model.ResumeProcessesRequest)"> <summary> Resumes the specified suspended Auto Scaling processes, or all suspended process, for the specified Auto Scaling group. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ResumeProcesses service method.</param> <returns>The response from the ResumeProcesses service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceInUseException"> The Auto Scaling group or launch configuration can't be deleted because it is in use. </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.ResumeProcessesAsync(Amazon.AutoScaling.Model.ResumeProcessesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResumeProcesses operation. </summary> <param name="request">Container for the necessary parameters to execute the ResumeProcesses operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.SetDesiredCapacity(Amazon.AutoScaling.Model.SetDesiredCapacityRequest)"> <summary> Sets the size of the specified Auto Scaling group. <para> For more information about desired capacity, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/WhatIsAutoScaling.html">What Is Auto Scaling?</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetDesiredCapacity service method.</param> <returns>The response from the SetDesiredCapacity service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.SetDesiredCapacityAsync(Amazon.AutoScaling.Model.SetDesiredCapacityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetDesiredCapacity operation. </summary> <param name="request">Container for the necessary parameters to execute the SetDesiredCapacity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.SetInstanceHealth(Amazon.AutoScaling.Model.SetInstanceHealthRequest)"> <summary> Sets the health status of the specified instance. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/healthcheck.html">Health Checks</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetInstanceHealth service method.</param> <returns>The response from the SetInstanceHealth service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.SetInstanceHealthAsync(Amazon.AutoScaling.Model.SetInstanceHealthRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetInstanceHealth operation. </summary> <param name="request">Container for the necessary parameters to execute the SetInstanceHealth operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.SetInstanceProtection(Amazon.AutoScaling.Model.SetInstanceProtectionRequest)"> <summary> Updates the instance protection settings of the specified instances. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingBehavior.InstanceTermination.html#instance-protection">Instance Protection</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetInstanceProtection service method.</param> <returns>The response from the SetInstanceProtection service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.SetInstanceProtectionAsync(Amazon.AutoScaling.Model.SetInstanceProtectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetInstanceProtection operation. </summary> <param name="request">Container for the necessary parameters to execute the SetInstanceProtection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.SuspendProcesses(Amazon.AutoScaling.Model.SuspendProcessesRequest)"> <summary> Suspends the specified Auto Scaling processes, or all processes, for the specified Auto Scaling group. <para> Note that if you suspend either the <code>Launch</code> or <code>Terminate</code> process types, it can prevent other process types from functioning properly. </para> <para> To resume processes that have been suspended, use <a>ResumeProcesses</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SuspendProcesses service method.</param> <returns>The response from the SuspendProcesses service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceInUseException"> The Auto Scaling group or launch configuration can't be deleted because it is in use. </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.SuspendProcessesAsync(Amazon.AutoScaling.Model.SuspendProcessesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SuspendProcesses operation. </summary> <param name="request">Container for the necessary parameters to execute the SuspendProcesses operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.TerminateInstanceInAutoScalingGroup(Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest)"> <summary> Terminates the specified instance and optionally adjusts the desired group size. <para> This call simply makes a termination request. The instance is not terminated immediately. </para> </summary> <param name="request">Container for the necessary parameters to execute the TerminateInstanceInAutoScalingGroup service method.</param> <returns>The response from the TerminateInstanceInAutoScalingGroup service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.TerminateInstanceInAutoScalingGroupAsync(Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TerminateInstanceInAutoScalingGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the TerminateInstanceInAutoScalingGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.UpdateAutoScalingGroup(Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest)"> <summary> Updates the configuration for the specified Auto Scaling group. <para> To update an Auto Scaling group with a launch configuration with <code>InstanceMonitoring</code> set to <code>False</code>, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using <a>DisableMetricsCollection</a>. </para> <para> The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected. </para> <para> Note the following: </para> <ul> <li> <para> If you specify a new value for <code>MinSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MinSize</code> is larger than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MinSize</code>. </para> </li> <li> <para> If you specify a new value for <code>MaxSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MaxSize</code> is smaller than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MaxSize</code>. </para> </li> <li> <para> All other optional parameters are left unchanged if not specified. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAutoScalingGroup service method.</param> <returns>The response from the UpdateAutoScalingGroup service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.UpdateAutoScalingGroupAsync(Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAutoScalingGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAutoScalingGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor"> <summary> Constructs AmazonAutoScalingClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonAutoScalingClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(Amazon.AutoScaling.AmazonAutoScalingConfig)"> <summary> Constructs AmazonAutoScalingClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonAutoScalingClient Configuration Object</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonAutoScalingClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonAutoScalingClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.AutoScaling.AmazonAutoScalingConfig)"> <summary> Constructs AmazonAutoScalingClient with AWS Credentials and an AmazonAutoScalingClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonAutoScalingClient Configuration Object</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonAutoScalingClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonAutoScalingClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(System.String,System.String,Amazon.AutoScaling.AmazonAutoScalingConfig)"> <summary> Constructs AmazonAutoScalingClient with AWS Access Key ID, AWS Secret Key and an AmazonAutoScalingClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonAutoScalingClient Configuration Object</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonAutoScalingClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonAutoScalingClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(System.String,System.String,System.String,Amazon.AutoScaling.AmazonAutoScalingConfig)"> <summary> Constructs AmazonAutoScalingClient with AWS Access Key ID, AWS Secret Key and an AmazonAutoScalingClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonAutoScalingClient Configuration Object</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.AttachInstances(Amazon.AutoScaling.Model.AttachInstancesRequest)"> <summary> Attaches one or more EC2 instances to the specified Auto Scaling group. <para> When you attach instances, Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-instance-asg.html">Attach EC2 Instances to Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachInstances service method.</param> <returns>The response from the AttachInstances service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.AttachInstancesAsync(Amazon.AutoScaling.Model.AttachInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.AttachLoadBalancers(Amazon.AutoScaling.Model.AttachLoadBalancersRequest)"> <summary> Attaches one or more load balancers to the specified Auto Scaling group. <para> To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use <a>DetachLoadBalancers</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-load-balancer-asg.html">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachLoadBalancers service method.</param> <returns>The response from the AttachLoadBalancers service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.AttachLoadBalancersAsync(Amazon.AutoScaling.Model.AttachLoadBalancersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachLoadBalancers operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachLoadBalancers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.CompleteLifecycleAction(Amazon.AutoScaling.Model.CompleteLifecycleActionRequest)"> <summary> Completes the lifecycle action for the specified token or instance with the specified result. <para> This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: </para> <ol> <li>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</li> <li>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</li> <li>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</li> <li>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</li> <li><b>If you finish before the timeout period ends, complete the lifecycle action.</b></li> </ol> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CompleteLifecycleAction service method.</param> <returns>The response from the CompleteLifecycleAction service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.CompleteLifecycleActionAsync(Amazon.AutoScaling.Model.CompleteLifecycleActionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CompleteLifecycleAction operation. </summary> <param name="request">Container for the necessary parameters to execute the CompleteLifecycleAction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.CreateAutoScalingGroup(Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest)"> <summary> Creates an Auto Scaling group with the specified name and attributes. <para> If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroup.html">Auto Scaling Groups</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateAutoScalingGroup service method.</param> <returns>The response from the CreateAutoScalingGroup service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.AlreadyExistsException"> You already have an Auto Scaling group or launch configuration with this name. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.CreateAutoScalingGroupAsync(Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAutoScalingGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAutoScalingGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.CreateLaunchConfiguration(Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest)"> <summary> Creates a launch configuration. <para> If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/LaunchConfiguration.html">Launch Configurations</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLaunchConfiguration service method.</param> <returns>The response from the CreateLaunchConfiguration service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.AlreadyExistsException"> You already have an Auto Scaling group or launch configuration with this name. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.CreateLaunchConfigurationAsync(Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLaunchConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLaunchConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.CreateOrUpdateTags(Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest)"> <summary> Creates or updates tags for the specified Auto Scaling group. <para> When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateOrUpdateTags service method.</param> <returns>The response from the CreateOrUpdateTags service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.AlreadyExistsException"> You already have an Auto Scaling group or launch configuration with this name. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.CreateOrUpdateTagsAsync(Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateOrUpdateTags operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateOrUpdateTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteAutoScalingGroup(Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest)"> <summary> Deletes the specified Auto Scaling group. <para> If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. </para> <para> If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action. </para> <para> To remove instances from the Auto Scaling group before deleting it, call <a>DetachInstances</a> with the list of instances and the option to decrement the desired capacity so that Auto Scaling does not launch replacement instances. </para> <para> To terminate all instances before deleting the Auto Scaling group, call <a>UpdateAutoScalingGroup</a> and set the minimum size and desired capacity of the Auto Scaling group to zero. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAutoScalingGroup service method.</param> <returns>The response from the DeleteAutoScalingGroup service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceInUseException"> The Auto Scaling group or launch configuration can't be deleted because it is in use. </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteAutoScalingGroupAsync(Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAutoScalingGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAutoScalingGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteLaunchConfiguration(Amazon.AutoScaling.Model.DeleteLaunchConfigurationRequest)"> <summary> Deletes the specified launch configuration. <para> The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLaunchConfiguration service method.</param> <returns>The response from the DeleteLaunchConfiguration service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceInUseException"> The Auto Scaling group or launch configuration can't be deleted because it is in use. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteLaunchConfigurationAsync(Amazon.AutoScaling.Model.DeleteLaunchConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLaunchConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLaunchConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteLifecycleHook(Amazon.AutoScaling.Model.DeleteLifecycleHookRequest)"> <summary> Deletes the specified lifecycle hook. <para> If there are any outstanding lifecycle actions, they are completed first (<code>ABANDON</code> for launching instances, <code>CONTINUE</code> for terminating instances). </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLifecycleHook service method.</param> <returns>The response from the DeleteLifecycleHook service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteLifecycleHookAsync(Amazon.AutoScaling.Model.DeleteLifecycleHookRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLifecycleHook operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLifecycleHook operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteNotificationConfiguration(Amazon.AutoScaling.Model.DeleteNotificationConfigurationRequest)"> <summary> Deletes the specified notification. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNotificationConfiguration service method.</param> <returns>The response from the DeleteNotificationConfiguration service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteNotificationConfigurationAsync(Amazon.AutoScaling.Model.DeleteNotificationConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteNotificationConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNotificationConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeletePolicy(Amazon.AutoScaling.Model.DeletePolicyRequest)"> <summary> Deletes the specified Auto Scaling policy. <para> Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeletePolicy service method.</param> <returns>The response from the DeletePolicy service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeletePolicyAsync(Amazon.AutoScaling.Model.DeletePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteScheduledAction(Amazon.AutoScaling.Model.DeleteScheduledActionRequest)"> <summary> Deletes the specified scheduled action. </summary> <param name="request">Container for the necessary parameters to execute the DeleteScheduledAction service method.</param> <returns>The response from the DeleteScheduledAction service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteScheduledActionAsync(Amazon.AutoScaling.Model.DeleteScheduledActionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteScheduledAction operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteScheduledAction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteTags(Amazon.AutoScaling.Model.DeleteTagsRequest)"> <summary> Deletes the specified tags. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags service method.</param> <returns>The response from the DeleteTags service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteTagsAsync(Amazon.AutoScaling.Model.DeleteTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAccountLimits"> <summary> Describes the current Auto Scaling resource limits for your AWS account. <para> For information about requesting an increase in these limits, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> <returns>The response from the DescribeAccountLimits service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAccountLimits(Amazon.AutoScaling.Model.DescribeAccountLimitsRequest)"> <summary> Describes the current Auto Scaling resource limits for your AWS account. <para> For information about requesting an increase in these limits, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountLimits service method.</param> <returns>The response from the DescribeAccountLimits service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAccountLimitsAsync(Amazon.AutoScaling.Model.DescribeAccountLimitsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAccountLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountLimits operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAdjustmentTypes"> <summary> Describes the policy adjustment types for use with <a>PutScalingPolicy</a>. </summary> <returns>The response from the DescribeAdjustmentTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAdjustmentTypes(Amazon.AutoScaling.Model.DescribeAdjustmentTypesRequest)"> <summary> Describes the policy adjustment types for use with <a>PutScalingPolicy</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAdjustmentTypes service method.</param> <returns>The response from the DescribeAdjustmentTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAdjustmentTypesAsync(Amazon.AutoScaling.Model.DescribeAdjustmentTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAdjustmentTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAdjustmentTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingGroups"> <summary> Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups. </summary> <returns>The response from the DescribeAutoScalingGroups service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingGroups(Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest)"> <summary> Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingGroups service method.</param> <returns>The response from the DescribeAutoScalingGroups service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingGroupsAsync(Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingInstances"> <summary> Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances. </summary> <returns>The response from the DescribeAutoScalingInstances service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingInstances(Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest)"> <summary> Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingInstances service method.</param> <returns>The response from the DescribeAutoScalingInstances service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingInstancesAsync(Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingNotificationTypes"> <summary> Describes the notification types that are supported by Auto Scaling. </summary> <returns>The response from the DescribeAutoScalingNotificationTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingNotificationTypes(Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesRequest)"> <summary> Describes the notification types that are supported by Auto Scaling. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingNotificationTypes service method.</param> <returns>The response from the DescribeAutoScalingNotificationTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingNotificationTypesAsync(Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingNotificationTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingNotificationTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeLaunchConfigurations"> <summary> Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations. </summary> <returns>The response from the DescribeLaunchConfigurations service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeLaunchConfigurations(Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest)"> <summary> Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLaunchConfigurations service method.</param> <returns>The response from the DescribeLaunchConfigurations service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeLaunchConfigurationsAsync(Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLaunchConfigurations operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLaunchConfigurations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeLifecycleHooks(Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest)"> <summary> Describes the lifecycle hooks for the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLifecycleHooks service method.</param> <returns>The response from the DescribeLifecycleHooks service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeLifecycleHooksAsync(Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLifecycleHooks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLifecycleHooks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeLifecycleHookTypes(Amazon.AutoScaling.Model.DescribeLifecycleHookTypesRequest)"> <summary> Describes the available types of lifecycle hooks. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLifecycleHookTypes service method.</param> <returns>The response from the DescribeLifecycleHookTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeLifecycleHookTypesAsync(Amazon.AutoScaling.Model.DescribeLifecycleHookTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLifecycleHookTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLifecycleHookTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeLoadBalancers(Amazon.AutoScaling.Model.DescribeLoadBalancersRequest)"> <summary> Describes the load balancers for the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancers service method.</param> <returns>The response from the DescribeLoadBalancers service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeLoadBalancersAsync(Amazon.AutoScaling.Model.DescribeLoadBalancersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancers operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeMetricCollectionTypes"> <summary> Describes the available CloudWatch metrics for Auto Scaling. <para> Note that the <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request this metric when calling <a>EnableMetricsCollection</a>. </para> </summary> <returns>The response from the DescribeMetricCollectionTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeMetricCollectionTypes(Amazon.AutoScaling.Model.DescribeMetricCollectionTypesRequest)"> <summary> Describes the available CloudWatch metrics for Auto Scaling. <para> Note that the <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request this metric when calling <a>EnableMetricsCollection</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeMetricCollectionTypes service method.</param> <returns>The response from the DescribeMetricCollectionTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeMetricCollectionTypesAsync(Amazon.AutoScaling.Model.DescribeMetricCollectionTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeMetricCollectionTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMetricCollectionTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeNotificationConfigurations"> <summary> Describes the notification actions associated with the specified Auto Scaling group. </summary> <returns>The response from the DescribeNotificationConfigurations service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeNotificationConfigurations(Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest)"> <summary> Describes the notification actions associated with the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNotificationConfigurations service method.</param> <returns>The response from the DescribeNotificationConfigurations service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeNotificationConfigurationsAsync(Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeNotificationConfigurations operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNotificationConfigurations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribePolicies"> <summary> Describes the policies for the specified Auto Scaling group. </summary> <returns>The response from the DescribePolicies service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribePolicies(Amazon.AutoScaling.Model.DescribePoliciesRequest)"> <summary> Describes the policies for the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DescribePolicies service method.</param> <returns>The response from the DescribePolicies service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribePoliciesAsync(Amazon.AutoScaling.Model.DescribePoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribePolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScalingActivities"> <summary> Describes one or more scaling activities for the specified Auto Scaling group. If you omit the <code>ActivityIds</code>, the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list. </summary> <returns>The response from the DescribeScalingActivities service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScalingActivities(Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest)"> <summary> Describes one or more scaling activities for the specified Auto Scaling group. If you omit the <code>ActivityIds</code>, the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingActivities service method.</param> <returns>The response from the DescribeScalingActivities service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScalingActivitiesAsync(Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeScalingActivities operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingActivities operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScalingProcessTypes"> <summary> Describes the scaling process types for use with <a>ResumeProcesses</a> and <a>SuspendProcesses</a>. </summary> <returns>The response from the DescribeScalingProcessTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScalingProcessTypes(Amazon.AutoScaling.Model.DescribeScalingProcessTypesRequest)"> <summary> Describes the scaling process types for use with <a>ResumeProcesses</a> and <a>SuspendProcesses</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingProcessTypes service method.</param> <returns>The response from the DescribeScalingProcessTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScalingProcessTypesAsync(Amazon.AutoScaling.Model.DescribeScalingProcessTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeScalingProcessTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingProcessTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScheduledActions"> <summary> Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use <a>DescribeScalingActivities</a>. </summary> <returns>The response from the DescribeScheduledActions service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScheduledActions(Amazon.AutoScaling.Model.DescribeScheduledActionsRequest)"> <summary> Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use <a>DescribeScalingActivities</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScheduledActions service method.</param> <returns>The response from the DescribeScheduledActions service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScheduledActionsAsync(Amazon.AutoScaling.Model.DescribeScheduledActionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeScheduledActions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScheduledActions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeTags"> <summary> Describes the specified tags. <para> You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. </para> <para> You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned. </para> </summary> <returns>The response from the DescribeTags service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeTags(Amazon.AutoScaling.Model.DescribeTagsRequest)"> <summary> Describes the specified tags. <para> You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. </para> <para> You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags service method.</param> <returns>The response from the DescribeTags service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeTagsAsync(Amazon.AutoScaling.Model.DescribeTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeTerminationPolicyTypes"> <summary> Describes the termination policies supported by Auto Scaling. </summary> <returns>The response from the DescribeTerminationPolicyTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeTerminationPolicyTypes(Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesRequest)"> <summary> Describes the termination policies supported by Auto Scaling. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTerminationPolicyTypes service method.</param> <returns>The response from the DescribeTerminationPolicyTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeTerminationPolicyTypesAsync(Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTerminationPolicyTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTerminationPolicyTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DetachInstances(Amazon.AutoScaling.Model.DetachInstancesRequest)"> <summary> Removes one or more instances from the specified Auto Scaling group. <para> After the instances are detached, you can manage them independently from the rest of the Auto Scaling group. </para> <para> If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/detach-instance-asg.html">Detach EC2 Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachInstances service method.</param> <returns>The response from the DetachInstances service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DetachInstancesAsync(Amazon.AutoScaling.Model.DetachInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DetachLoadBalancers(Amazon.AutoScaling.Model.DetachLoadBalancersRequest)"> <summary> Removes one or more load balancers from the specified Auto Scaling group. <para> When you detach a load balancer, it enters the <code>Removing</code> state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using <a>DescribeLoadBalancers</a>. Note that the instances remain running. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachLoadBalancers service method.</param> <returns>The response from the DetachLoadBalancers service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DetachLoadBalancersAsync(Amazon.AutoScaling.Model.DetachLoadBalancersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachLoadBalancers operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachLoadBalancers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DisableMetricsCollection(Amazon.AutoScaling.Model.DisableMetricsCollectionRequest)"> <summary> Disables monitoring of the specified metrics for the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DisableMetricsCollection service method.</param> <returns>The response from the DisableMetricsCollection service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DisableMetricsCollectionAsync(Amazon.AutoScaling.Model.DisableMetricsCollectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableMetricsCollection operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableMetricsCollection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EnableMetricsCollection(Amazon.AutoScaling.Model.EnableMetricsCollectionRequest)"> <summary> Enables monitoring of the specified metrics for the specified Auto Scaling group. <para> You can only enable metrics collection if <code>InstanceMonitoring</code> in the launch configuration for the group is set to <code>True</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the EnableMetricsCollection service method.</param> <returns>The response from the EnableMetricsCollection service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EnableMetricsCollectionAsync(Amazon.AutoScaling.Model.EnableMetricsCollectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableMetricsCollection operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableMetricsCollection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EnterStandby(Amazon.AutoScaling.Model.EnterStandbyRequest)"> <summary> Moves the specified instances into <code>Standby</code> mode. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the EnterStandby service method.</param> <returns>The response from the EnterStandby service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EnterStandbyAsync(Amazon.AutoScaling.Model.EnterStandbyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnterStandby operation. </summary> <param name="request">Container for the necessary parameters to execute the EnterStandby operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.ExecutePolicy(Amazon.AutoScaling.Model.ExecutePolicyRequest)"> <summary> Executes the specified policy. </summary> <param name="request">Container for the necessary parameters to execute the ExecutePolicy service method.</param> <returns>The response from the ExecutePolicy service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.ExecutePolicyAsync(Amazon.AutoScaling.Model.ExecutePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ExecutePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the ExecutePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.ExitStandby(Amazon.AutoScaling.Model.ExitStandbyRequest)"> <summary> Moves the specified instances out of <code>Standby</code> mode. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ExitStandby service method.</param> <returns>The response from the ExitStandby service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.ExitStandbyAsync(Amazon.AutoScaling.Model.ExitStandbyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ExitStandby operation. </summary> <param name="request">Container for the necessary parameters to execute the ExitStandby operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.PutLifecycleHook(Amazon.AutoScaling.Model.PutLifecycleHookRequest)"> <summary> Creates or updates a lifecycle hook for the specified Auto Scaling Group. <para> A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates. </para> <para> This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: </para> <ol> <li>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</li> <li>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</li> <li><b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b></li> <li>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</li> <li>If you finish before the timeout period ends, complete the lifecycle action.</li> </ol> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> <para> If you exceed your maximum limit of lifecycle hooks, which by default is 50 per region, the call fails. For information about updating this limit, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutLifecycleHook service method.</param> <returns>The response from the PutLifecycleHook service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.PutLifecycleHookAsync(Amazon.AutoScaling.Model.PutLifecycleHookRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutLifecycleHook operation. </summary> <param name="request">Container for the necessary parameters to execute the PutLifecycleHook operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.PutNotificationConfiguration(Amazon.AutoScaling.Model.PutNotificationConfigurationRequest)"> <summary> Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to this topic can have messages for events delivered to an endpoint such as a web server or email address. <para> For more information see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASGettingNotifications.html">Getting Notifications When Your Auto Scaling Group Changes</a> in the <i>Auto Scaling Developer Guide</i>. </para> <para> This configuration overwrites an existing configuration. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutNotificationConfiguration service method.</param> <returns>The response from the PutNotificationConfiguration service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.PutNotificationConfigurationAsync(Amazon.AutoScaling.Model.PutNotificationConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutNotificationConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the PutNotificationConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.PutScalingPolicy(Amazon.AutoScaling.Model.PutScalingPolicyRequest)"> <summary> Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request. <para> If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutScalingPolicy service method.</param> <returns>The response from the PutScalingPolicy service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.PutScalingPolicyAsync(Amazon.AutoScaling.Model.PutScalingPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutScalingPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutScalingPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.PutScheduledUpdateGroupAction(Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest)"> <summary> Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/schedule_time.html">Scheduled Scaling</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutScheduledUpdateGroupAction service method.</param> <returns>The response from the PutScheduledUpdateGroupAction service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.AlreadyExistsException"> You already have an Auto Scaling group or launch configuration with this name. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.PutScheduledUpdateGroupActionAsync(Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutScheduledUpdateGroupAction operation. </summary> <param name="request">Container for the necessary parameters to execute the PutScheduledUpdateGroupAction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.RecordLifecycleActionHeartbeat(Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest)"> <summary> Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using <a>PutLifecycleHook</a>. <para> This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: </para> <ol> <li>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</li> <li>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</li> <li>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</li> <li><b>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</b></li> <li>If you finish before the timeout period ends, complete the lifecycle action.</li> </ol> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RecordLifecycleActionHeartbeat service method.</param> <returns>The response from the RecordLifecycleActionHeartbeat service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.RecordLifecycleActionHeartbeatAsync(Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RecordLifecycleActionHeartbeat operation. </summary> <param name="request">Container for the necessary parameters to execute the RecordLifecycleActionHeartbeat operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.ResumeProcesses(Amazon.AutoScaling.Model.ResumeProcessesRequest)"> <summary> Resumes the specified suspended Auto Scaling processes, or all suspended process, for the specified Auto Scaling group. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ResumeProcesses service method.</param> <returns>The response from the ResumeProcesses service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceInUseException"> The Auto Scaling group or launch configuration can't be deleted because it is in use. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.ResumeProcessesAsync(Amazon.AutoScaling.Model.ResumeProcessesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResumeProcesses operation. </summary> <param name="request">Container for the necessary parameters to execute the ResumeProcesses operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.SetDesiredCapacity(Amazon.AutoScaling.Model.SetDesiredCapacityRequest)"> <summary> Sets the size of the specified Auto Scaling group. <para> For more information about desired capacity, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/WhatIsAutoScaling.html">What Is Auto Scaling?</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetDesiredCapacity service method.</param> <returns>The response from the SetDesiredCapacity service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.SetDesiredCapacityAsync(Amazon.AutoScaling.Model.SetDesiredCapacityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetDesiredCapacity operation. </summary> <param name="request">Container for the necessary parameters to execute the SetDesiredCapacity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.SetInstanceHealth(Amazon.AutoScaling.Model.SetInstanceHealthRequest)"> <summary> Sets the health status of the specified instance. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/healthcheck.html">Health Checks</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetInstanceHealth service method.</param> <returns>The response from the SetInstanceHealth service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.SetInstanceHealthAsync(Amazon.AutoScaling.Model.SetInstanceHealthRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetInstanceHealth operation. </summary> <param name="request">Container for the necessary parameters to execute the SetInstanceHealth operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.SetInstanceProtection(Amazon.AutoScaling.Model.SetInstanceProtectionRequest)"> <summary> Updates the instance protection settings of the specified instances. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingBehavior.InstanceTermination.html#instance-protection">Instance Protection</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetInstanceProtection service method.</param> <returns>The response from the SetInstanceProtection service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.SetInstanceProtectionAsync(Amazon.AutoScaling.Model.SetInstanceProtectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetInstanceProtection operation. </summary> <param name="request">Container for the necessary parameters to execute the SetInstanceProtection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.SuspendProcesses(Amazon.AutoScaling.Model.SuspendProcessesRequest)"> <summary> Suspends the specified Auto Scaling processes, or all processes, for the specified Auto Scaling group. <para> Note that if you suspend either the <code>Launch</code> or <code>Terminate</code> process types, it can prevent other process types from functioning properly. </para> <para> To resume processes that have been suspended, use <a>ResumeProcesses</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SuspendProcesses service method.</param> <returns>The response from the SuspendProcesses service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceInUseException"> The Auto Scaling group or launch configuration can't be deleted because it is in use. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.SuspendProcessesAsync(Amazon.AutoScaling.Model.SuspendProcessesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SuspendProcesses operation. </summary> <param name="request">Container for the necessary parameters to execute the SuspendProcesses operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.TerminateInstanceInAutoScalingGroup(Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest)"> <summary> Terminates the specified instance and optionally adjusts the desired group size. <para> This call simply makes a termination request. The instance is not terminated immediately. </para> </summary> <param name="request">Container for the necessary parameters to execute the TerminateInstanceInAutoScalingGroup service method.</param> <returns>The response from the TerminateInstanceInAutoScalingGroup service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.TerminateInstanceInAutoScalingGroupAsync(Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TerminateInstanceInAutoScalingGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the TerminateInstanceInAutoScalingGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.UpdateAutoScalingGroup(Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest)"> <summary> Updates the configuration for the specified Auto Scaling group. <para> To update an Auto Scaling group with a launch configuration with <code>InstanceMonitoring</code> set to <code>False</code>, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using <a>DisableMetricsCollection</a>. </para> <para> The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected. </para> <para> Note the following: </para> <ul> <li> <para> If you specify a new value for <code>MinSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MinSize</code> is larger than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MinSize</code>. </para> </li> <li> <para> If you specify a new value for <code>MaxSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MaxSize</code> is smaller than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MaxSize</code>. </para> </li> <li> <para> All other optional parameters are left unchanged if not specified. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAutoScalingGroup service method.</param> <returns>The response from the UpdateAutoScalingGroup service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.UpdateAutoScalingGroupAsync(Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAutoScalingGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAutoScalingGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.AWSSupport.AmazonAWSSupportClient"> <summary> Implementation for accessing AWSSupport AWS Support <para> The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format. </para> <para> The AWS Support service also exposes a set of <a href="https://aws.amazon.com/premiumsupport/trustedadvisor/">Trusted Advisor</a> features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks. </para> <para> The following list describes the AWS Support case management operations: </para> <ul> <li> <b>Service names, issue categories, and available severity levels. </b>The <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> operations return AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the <a>CreateCase</a> operation. </li> <li> <b>Case creation, case details, and case resolution.</b> The <a>CreateCase</a>, <a>DescribeCases</a>, <a>DescribeAttachment</a>, and <a>ResolveCase</a> operations create AWS Support cases, retrieve information about cases, and resolve cases.</li> <li> <b>Case communication.</b> The <a>DescribeCommunications</a>, <a>AddCommunicationToCase</a>, and <a>AddAttachmentsToSet</a> operations retrieve and add communications and attachments to AWS Support cases. </li> </ul> <para> The following list describes the operations available from the AWS Support service for Trusted Advisor: </para> <ul> <li> <a>DescribeTrustedAdvisorChecks</a> returns the list of checks that run against your AWS resources.</li> <li>Using the <code>CheckId</code> for a specific check returned by <a>DescribeTrustedAdvisorChecks</a>, you can call <a>DescribeTrustedAdvisorCheckResult</a> to obtain the results for the check you specified.</li> <li> <a>DescribeTrustedAdvisorCheckSummaries</a> returns summarized results for one or more Trusted Advisor checks.</li> <li> <a>RefreshTrustedAdvisorCheck</a> requests that Trusted Advisor rerun a specified check. </li> <li> <a>DescribeTrustedAdvisorCheckRefreshStatuses</a> reports the refresh status of one or more checks. </li> </ul> <para> For authentication of requests, AWS Support uses <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. </para> <para> See <a href="http://docs.aws.amazon.com/awssupport/latest/user/Welcome.html">About the AWS Support API</a> in the <i>AWS Support User Guide</i> for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources. </para> </summary> </member> <member name="T:Amazon.AWSSupport.IAmazonAWSSupport"> <summary> Interface for accessing AWSSupport AWS Support <para> The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format. </para> <para> The AWS Support service also exposes a set of <a href="https://aws.amazon.com/premiumsupport/trustedadvisor/">Trusted Advisor</a> features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks. </para> <para> The following list describes the AWS Support case management operations: </para> <ul> <li> <b>Service names, issue categories, and available severity levels. </b>The <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> operations return AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the <a>CreateCase</a> operation. </li> <li> <b>Case creation, case details, and case resolution.</b> The <a>CreateCase</a>, <a>DescribeCases</a>, <a>DescribeAttachment</a>, and <a>ResolveCase</a> operations create AWS Support cases, retrieve information about cases, and resolve cases.</li> <li> <b>Case communication.</b> The <a>DescribeCommunications</a>, <a>AddCommunicationToCase</a>, and <a>AddAttachmentsToSet</a> operations retrieve and add communications and attachments to AWS Support cases. </li> </ul> <para> The following list describes the operations available from the AWS Support service for Trusted Advisor: </para> <ul> <li> <a>DescribeTrustedAdvisorChecks</a> returns the list of checks that run against your AWS resources.</li> <li>Using the <code>CheckId</code> for a specific check returned by <a>DescribeTrustedAdvisorChecks</a>, you can call <a>DescribeTrustedAdvisorCheckResult</a> to obtain the results for the check you specified.</li> <li> <a>DescribeTrustedAdvisorCheckSummaries</a> returns summarized results for one or more Trusted Advisor checks.</li> <li> <a>RefreshTrustedAdvisorCheck</a> requests that Trusted Advisor rerun a specified check. </li> <li> <a>DescribeTrustedAdvisorCheckRefreshStatuses</a> reports the refresh status of one or more checks. </li> </ul> <para> For authentication of requests, AWS Support uses <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. </para> <para> See <a href="http://docs.aws.amazon.com/awssupport/latest/user/Welcome.html">About the AWS Support API</a> in the <i>AWS Support User Guide</i> for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources. </para> </summary> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.AddAttachmentsToSet(Amazon.AWSSupport.Model.AddAttachmentsToSetRequest)"> <summary> Adds one or more attachments to an attachment set. If an <code>AttachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> is specified, the attachments are added to the specified set, if it exists. <para> An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the <code>ExpiryTime</code> returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddAttachmentsToSet service method.</param> <returns>The response from the AddAttachmentsToSet service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.AttachmentLimitExceededException"> The limit for the number of attachment sets created in a short period of time has been exceeded. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetExpiredException"> The expiration time of the attachment set has passed. The set expires 1 hour after it is created. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetIdNotFoundException"> An attachment set with the specified ID could not be found. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetSizeLimitExceededException"> A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.AddAttachmentsToSetAsync(Amazon.AWSSupport.Model.AddAttachmentsToSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddAttachmentsToSet operation. </summary> <param name="request">Container for the necessary parameters to execute the AddAttachmentsToSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.AddCommunicationToCase(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest)"> <summary> Adds additional customer communication to an AWS Support case. You use the <code>CaseId</code> value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the <code>CcEmailAddresses</code> value. The <code>CommunicationBody</code> value contains the text of the communication. <para> The response indicates the success or failure of the request. </para> <para> This operation implements a subset of the features of the AWS Support Center. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddCommunicationToCase service method.</param> <returns>The response from the AddCommunicationToCase service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetExpiredException"> The expiration time of the attachment set has passed. The set expires 1 hour after it is created. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetIdNotFoundException"> An attachment set with the specified ID could not be found. </exception> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> The requested <code>CaseId</code> could not be located. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.AddCommunicationToCaseAsync(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddCommunicationToCase operation. </summary> <param name="request">Container for the necessary parameters to execute the AddCommunicationToCase operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.CreateCase(Amazon.AWSSupport.Model.CreateCaseRequest)"> <summary> Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. Its parameters require you to specify the following information: <ol> <li> <b>IssueType.</b> The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical." </li> <li> <b>ServiceCode.</b> The code for an AWS service. You obtain the <code>ServiceCode</code> by calling <a>DescribeServices</a>. </li> <li> <b>CategoryCode.</b> The category for the service defined for the <code>ServiceCode</code> value. You also obtain the category code for a service by calling <a>DescribeServices</a>. Each AWS service defines its own set of category codes. </li> <li> <b>SeverityCode.</b> A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling <a>DescribeSeverityLevels</a>.</li> <li> <b>Subject.</b> The <b>Subject</b> field on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</li> <li> <b>CommunicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</li> <li> <b>AttachmentSetId.</b> The ID of a set of attachments that has been created by using <a>AddAttachmentsToSet</a>.</li> <li> <b>Language.</b> The human language in which AWS Support handles the case. English and Japanese are currently supported.</li> <li> <b>CcEmailAddresses.</b> The AWS Support Center <b>CC</b> field on the <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an <a href="http://aws.amazon.com/tools/">AWS SDK</a>. </li> </ol> <note> <para> To add additional communication or attachments to an existing case, use <a>AddCommunicationToCase</a>. </para> </note> <para> A successful <a>CreateCase</a> request returns an AWS Support case number. Case numbers are used by the <a>DescribeCases</a> operation to retrieve existing AWS Support cases. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateCase service method.</param> <returns>The response from the CreateCase service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetExpiredException"> The expiration time of the attachment set has passed. The set expires 1 hour after it is created. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetIdNotFoundException"> An attachment set with the specified ID could not be found. </exception> <exception cref="T:Amazon.AWSSupport.Model.CaseCreationLimitExceededException"> The case creation limit for the account has been exceeded. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.CreateCaseAsync(Amazon.AWSSupport.Model.CreateCaseRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCase operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCase operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeAttachment(Amazon.AWSSupport.Model.DescribeAttachmentRequest)"> <summary> Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the <a>AttachmentDetails</a> objects that are returned by the <a>DescribeCommunications</a> operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAttachment service method.</param> <returns>The response from the DescribeAttachment service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.AttachmentIdNotFoundException"> An attachment with the specified ID could not be found. </exception> <exception cref="T:Amazon.AWSSupport.Model.DescribeAttachmentLimitExceededException"> The limit for the number of <a>DescribeAttachment</a> requests in a short period of time has been exceeded. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeAttachmentAsync(Amazon.AWSSupport.Model.DescribeAttachmentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAttachment operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAttachment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeCases(Amazon.AWSSupport.Model.DescribeCasesRequest)"> <summary> Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the <code>AfterTime</code> and <code>BeforeTime</code> request parameters. You can set values for the <code>IncludeResolvedCases</code> and <code>IncludeCommunications</code> request parameters to control how much information is returned. <para> Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </para> <para> The response returns the following in JSON format: </para> <ol> <li>One or more <a>CaseDetails</a> data types. </li> <li>One or more <code>NextToken</code> values, which specify where to paginate the returned records represented by the <code>CaseDetails</code> objects.</li> </ol> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCases service method.</param> <returns>The response from the DescribeCases service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> The requested <code>CaseId</code> could not be located. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeCasesAsync(Amazon.AWSSupport.Model.DescribeCasesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCases operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCases operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeCommunications(Amazon.AWSSupport.Model.DescribeCommunicationsRequest)"> <summary> Returns communications (and attachments) for one or more support cases. You can use the <code>AfterTime</code> and <code>BeforeTime</code> parameters to filter by date. You can use the <code>CaseId</code> parameter to restrict the results to a particular case. <para> Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </para> <para> You can use the <code>MaxResults</code> and <code>NextToken</code> parameters to control the pagination of the result set. Set <code>MaxResults</code> to the number of cases you want displayed on each page, and use <code>NextToken</code> to specify the resumption of pagination. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCommunications service method.</param> <returns>The response from the DescribeCommunications service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> The requested <code>CaseId</code> could not be located. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeCommunicationsAsync(Amazon.AWSSupport.Model.DescribeCommunicationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCommunications operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCommunications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeServices"> <summary> Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of categories. <para> The service codes and category codes correspond to the values that are displayed in the <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <code>DescribeServices</code> request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. </para> </summary> <returns>The response from the DescribeServices service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeServices(Amazon.AWSSupport.Model.DescribeServicesRequest)"> <summary> Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of categories. <para> The service codes and category codes correspond to the values that are displayed in the <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <code>DescribeServices</code> request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeServices service method.</param> <returns>The response from the DescribeServices service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeServicesAsync(Amazon.AWSSupport.Model.DescribeServicesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeServices operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServices operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeSeverityLevels"> <summary> Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the <a>CaseDetails</a> data type included in any <a>CreateCase</a> request. </summary> <returns>The response from the DescribeSeverityLevels service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeSeverityLevels(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest)"> <summary> Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the <a>CaseDetails</a> data type included in any <a>CreateCase</a> request. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSeverityLevels service method.</param> <returns>The response from the DescribeSeverityLevels service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeSeverityLevelsAsync(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSeverityLevels operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSeverityLevels operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeTrustedAdvisorCheckRefreshStatuses(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest)"> <summary> Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses service method.</param> <returns>The response from the DescribeTrustedAdvisorCheckRefreshStatuses service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeTrustedAdvisorCheckRefreshStatusesAsync(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeTrustedAdvisorCheckResult(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest)"> <summary> Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains a <a>TrustedAdvisorCheckResult</a> object, which contains these three objects: </para> <ul> <li><a>TrustedAdvisorCategorySpecificSummary</a></li> <li><a>TrustedAdvisorResourceDetail</a></li> <li><a>TrustedAdvisorResourcesSummary</a></li> </ul> <para> In addition, the response contains these fields: </para> <ul> <li> <b>Status.</b> The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".</li> <li> <b>Timestamp.</b> The time of the last refresh of the check.</li> <li> <b>CheckId.</b> The unique identifier for the check.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult service method.</param> <returns>The response from the DescribeTrustedAdvisorCheckResult service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeTrustedAdvisorCheckResultAsync(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeTrustedAdvisorChecks(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest)"> <summary> Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a <a>TrustedAdvisorCheckDescription</a> for each check. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks service method.</param> <returns>The response from the DescribeTrustedAdvisorChecks service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeTrustedAdvisorChecksAsync(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorChecks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeTrustedAdvisorCheckSummaries(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest)"> <summary> Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains an array of <a>TrustedAdvisorCheckSummary</a> objects. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries service method.</param> <returns>The response from the DescribeTrustedAdvisorCheckSummaries service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeTrustedAdvisorCheckSummariesAsync(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.RefreshTrustedAdvisorCheck(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest)"> <summary> Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains a <a>TrustedAdvisorCheckRefreshStatus</a> object, which contains these fields: </para> <ul> <li> <b>Status.</b> The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".</li> <li> <b>MillisUntilNextRefreshable.</b> The amount of time, in milliseconds, until the check is eligible for refresh.</li> <li> <b>CheckId.</b> The unique identifier for the check.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck service method.</param> <returns>The response from the RefreshTrustedAdvisorCheck service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.RefreshTrustedAdvisorCheckAsync(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RefreshTrustedAdvisorCheck operation. </summary> <param name="request">Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.ResolveCase(Amazon.AWSSupport.Model.ResolveCaseRequest)"> <summary> Takes a <code>CaseId</code> and returns the initial state of the case along with the state of the case after the call to <a>ResolveCase</a> completed. </summary> <param name="request">Container for the necessary parameters to execute the ResolveCase service method.</param> <returns>The response from the ResolveCase service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> The requested <code>CaseId</code> could not be located. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.ResolveCaseAsync(Amazon.AWSSupport.Model.ResolveCaseRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResolveCase operation. </summary> <param name="request">Container for the necessary parameters to execute the ResolveCase operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor"> <summary> Constructs AmazonAWSSupportClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonAWSSupportClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(Amazon.AWSSupport.AmazonAWSSupportConfig)"> <summary> Constructs AmazonAWSSupportClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonAWSSupportClient Configuration Object</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonAWSSupportClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonAWSSupportClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.AWSSupport.AmazonAWSSupportConfig)"> <summary> Constructs AmazonAWSSupportClient with AWS Credentials and an AmazonAWSSupportClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonAWSSupportClient Configuration Object</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(System.String,System.String,Amazon.AWSSupport.AmazonAWSSupportConfig)"> <summary> Constructs AmazonAWSSupportClient with AWS Access Key ID, AWS Secret Key and an AmazonAWSSupportClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonAWSSupportClient Configuration Object</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(System.String,System.String,System.String,Amazon.AWSSupport.AmazonAWSSupportConfig)"> <summary> Constructs AmazonAWSSupportClient with AWS Access Key ID, AWS Secret Key and an AmazonAWSSupportClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonAWSSupportClient Configuration Object</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.AddAttachmentsToSet(Amazon.AWSSupport.Model.AddAttachmentsToSetRequest)"> <summary> Adds one or more attachments to an attachment set. If an <code>AttachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> is specified, the attachments are added to the specified set, if it exists. <para> An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the <code>ExpiryTime</code> returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddAttachmentsToSet service method.</param> <returns>The response from the AddAttachmentsToSet service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.AttachmentLimitExceededException"> The limit for the number of attachment sets created in a short period of time has been exceeded. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetExpiredException"> The expiration time of the attachment set has passed. The set expires 1 hour after it is created. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetIdNotFoundException"> An attachment set with the specified ID could not be found. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetSizeLimitExceededException"> A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.AddAttachmentsToSetAsync(Amazon.AWSSupport.Model.AddAttachmentsToSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddAttachmentsToSet operation. </summary> <param name="request">Container for the necessary parameters to execute the AddAttachmentsToSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.AddCommunicationToCase(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest)"> <summary> Adds additional customer communication to an AWS Support case. You use the <code>CaseId</code> value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the <code>CcEmailAddresses</code> value. The <code>CommunicationBody</code> value contains the text of the communication. <para> The response indicates the success or failure of the request. </para> <para> This operation implements a subset of the features of the AWS Support Center. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddCommunicationToCase service method.</param> <returns>The response from the AddCommunicationToCase service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetExpiredException"> The expiration time of the attachment set has passed. The set expires 1 hour after it is created. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetIdNotFoundException"> An attachment set with the specified ID could not be found. </exception> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> The requested <code>CaseId</code> could not be located. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.AddCommunicationToCaseAsync(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddCommunicationToCase operation. </summary> <param name="request">Container for the necessary parameters to execute the AddCommunicationToCase operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.CreateCase(Amazon.AWSSupport.Model.CreateCaseRequest)"> <summary> Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. Its parameters require you to specify the following information: <ol> <li> <b>IssueType.</b> The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical." </li> <li> <b>ServiceCode.</b> The code for an AWS service. You obtain the <code>ServiceCode</code> by calling <a>DescribeServices</a>. </li> <li> <b>CategoryCode.</b> The category for the service defined for the <code>ServiceCode</code> value. You also obtain the category code for a service by calling <a>DescribeServices</a>. Each AWS service defines its own set of category codes. </li> <li> <b>SeverityCode.</b> A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling <a>DescribeSeverityLevels</a>.</li> <li> <b>Subject.</b> The <b>Subject</b> field on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</li> <li> <b>CommunicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</li> <li> <b>AttachmentSetId.</b> The ID of a set of attachments that has been created by using <a>AddAttachmentsToSet</a>.</li> <li> <b>Language.</b> The human language in which AWS Support handles the case. English and Japanese are currently supported.</li> <li> <b>CcEmailAddresses.</b> The AWS Support Center <b>CC</b> field on the <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an <a href="http://aws.amazon.com/tools/">AWS SDK</a>. </li> </ol> <note> <para> To add additional communication or attachments to an existing case, use <a>AddCommunicationToCase</a>. </para> </note> <para> A successful <a>CreateCase</a> request returns an AWS Support case number. Case numbers are used by the <a>DescribeCases</a> operation to retrieve existing AWS Support cases. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateCase service method.</param> <returns>The response from the CreateCase service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetExpiredException"> The expiration time of the attachment set has passed. The set expires 1 hour after it is created. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetIdNotFoundException"> An attachment set with the specified ID could not be found. </exception> <exception cref="T:Amazon.AWSSupport.Model.CaseCreationLimitExceededException"> The case creation limit for the account has been exceeded. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.CreateCaseAsync(Amazon.AWSSupport.Model.CreateCaseRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCase operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCase operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeAttachment(Amazon.AWSSupport.Model.DescribeAttachmentRequest)"> <summary> Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the <a>AttachmentDetails</a> objects that are returned by the <a>DescribeCommunications</a> operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAttachment service method.</param> <returns>The response from the DescribeAttachment service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.AttachmentIdNotFoundException"> An attachment with the specified ID could not be found. </exception> <exception cref="T:Amazon.AWSSupport.Model.DescribeAttachmentLimitExceededException"> The limit for the number of <a>DescribeAttachment</a> requests in a short period of time has been exceeded. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeAttachmentAsync(Amazon.AWSSupport.Model.DescribeAttachmentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAttachment operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAttachment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeCases(Amazon.AWSSupport.Model.DescribeCasesRequest)"> <summary> Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the <code>AfterTime</code> and <code>BeforeTime</code> request parameters. You can set values for the <code>IncludeResolvedCases</code> and <code>IncludeCommunications</code> request parameters to control how much information is returned. <para> Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </para> <para> The response returns the following in JSON format: </para> <ol> <li>One or more <a>CaseDetails</a> data types. </li> <li>One or more <code>NextToken</code> values, which specify where to paginate the returned records represented by the <code>CaseDetails</code> objects.</li> </ol> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCases service method.</param> <returns>The response from the DescribeCases service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> The requested <code>CaseId</code> could not be located. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeCasesAsync(Amazon.AWSSupport.Model.DescribeCasesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCases operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCases operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeCommunications(Amazon.AWSSupport.Model.DescribeCommunicationsRequest)"> <summary> Returns communications (and attachments) for one or more support cases. You can use the <code>AfterTime</code> and <code>BeforeTime</code> parameters to filter by date. You can use the <code>CaseId</code> parameter to restrict the results to a particular case. <para> Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </para> <para> You can use the <code>MaxResults</code> and <code>NextToken</code> parameters to control the pagination of the result set. Set <code>MaxResults</code> to the number of cases you want displayed on each page, and use <code>NextToken</code> to specify the resumption of pagination. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCommunications service method.</param> <returns>The response from the DescribeCommunications service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> The requested <code>CaseId</code> could not be located. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeCommunicationsAsync(Amazon.AWSSupport.Model.DescribeCommunicationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCommunications operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCommunications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeServices"> <summary> Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of categories. <para> The service codes and category codes correspond to the values that are displayed in the <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <code>DescribeServices</code> request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. </para> </summary> <returns>The response from the DescribeServices service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeServices(Amazon.AWSSupport.Model.DescribeServicesRequest)"> <summary> Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of categories. <para> The service codes and category codes correspond to the values that are displayed in the <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <code>DescribeServices</code> request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeServices service method.</param> <returns>The response from the DescribeServices service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeServicesAsync(Amazon.AWSSupport.Model.DescribeServicesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeServices operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServices operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeSeverityLevels"> <summary> Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the <a>CaseDetails</a> data type included in any <a>CreateCase</a> request. </summary> <returns>The response from the DescribeSeverityLevels service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeSeverityLevels(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest)"> <summary> Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the <a>CaseDetails</a> data type included in any <a>CreateCase</a> request. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSeverityLevels service method.</param> <returns>The response from the DescribeSeverityLevels service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeSeverityLevelsAsync(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSeverityLevels operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSeverityLevels operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeTrustedAdvisorCheckRefreshStatuses(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest)"> <summary> Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses service method.</param> <returns>The response from the DescribeTrustedAdvisorCheckRefreshStatuses service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeTrustedAdvisorCheckRefreshStatusesAsync(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeTrustedAdvisorCheckResult(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest)"> <summary> Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains a <a>TrustedAdvisorCheckResult</a> object, which contains these three objects: </para> <ul> <li><a>TrustedAdvisorCategorySpecificSummary</a></li> <li><a>TrustedAdvisorResourceDetail</a></li> <li><a>TrustedAdvisorResourcesSummary</a></li> </ul> <para> In addition, the response contains these fields: </para> <ul> <li> <b>Status.</b> The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".</li> <li> <b>Timestamp.</b> The time of the last refresh of the check.</li> <li> <b>CheckId.</b> The unique identifier for the check.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult service method.</param> <returns>The response from the DescribeTrustedAdvisorCheckResult service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeTrustedAdvisorCheckResultAsync(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeTrustedAdvisorChecks(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest)"> <summary> Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a <a>TrustedAdvisorCheckDescription</a> for each check. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks service method.</param> <returns>The response from the DescribeTrustedAdvisorChecks service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeTrustedAdvisorChecksAsync(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorChecks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeTrustedAdvisorCheckSummaries(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest)"> <summary> Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains an array of <a>TrustedAdvisorCheckSummary</a> objects. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries service method.</param> <returns>The response from the DescribeTrustedAdvisorCheckSummaries service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeTrustedAdvisorCheckSummariesAsync(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.RefreshTrustedAdvisorCheck(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest)"> <summary> Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains a <a>TrustedAdvisorCheckRefreshStatus</a> object, which contains these fields: </para> <ul> <li> <b>Status.</b> The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".</li> <li> <b>MillisUntilNextRefreshable.</b> The amount of time, in milliseconds, until the check is eligible for refresh.</li> <li> <b>CheckId.</b> The unique identifier for the check.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck service method.</param> <returns>The response from the RefreshTrustedAdvisorCheck service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.RefreshTrustedAdvisorCheckAsync(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RefreshTrustedAdvisorCheck operation. </summary> <param name="request">Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.ResolveCase(Amazon.AWSSupport.Model.ResolveCaseRequest)"> <summary> Takes a <code>CaseId</code> and returns the initial state of the case along with the state of the case after the call to <a>ResolveCase</a> completed. </summary> <param name="request">Container for the necessary parameters to execute the ResolveCase service method.</param> <returns>The response from the ResolveCase service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> The requested <code>CaseId</code> could not be located. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.ResolveCaseAsync(Amazon.AWSSupport.Model.ResolveCaseRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResolveCase operation. </summary> <param name="request">Container for the necessary parameters to execute the ResolveCase operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.CloudHSM.AmazonCloudHSMClient"> <summary> Implementation for accessing CloudHSM AWS CloudHSM Service </summary> </member> <member name="T:Amazon.CloudHSM.IAmazonCloudHSM"> <summary> Interface for accessing CloudHSM AWS CloudHSM Service </summary> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.CreateHapg(System.String)"> <summary> Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs. </summary> <param name="label">The label of the new high-availability partition group.</param> <returns>The response from the CreateHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.CreateHapg(Amazon.CloudHSM.Model.CreateHapgRequest)"> <summary> Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs. </summary> <param name="request">Container for the necessary parameters to execute the CreateHapg service method.</param> <returns>The response from the CreateHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.CreateHapgAsync(Amazon.CloudHSM.Model.CreateHapgRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateHapg operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateHapg operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.CreateHsm(Amazon.CloudHSM.Model.CreateHsmRequest)"> <summary> Creates an uninitialized HSM instance. Running this command provisions an HSM appliance and will result in charges to your AWS account for the HSM. </summary> <param name="request">Container for the necessary parameters to execute the CreateHsm service method.</param> <returns>The response from the CreateHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.CreateHsmAsync(Amazon.CloudHSM.Model.CreateHsmRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateHsm operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateHsm operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.CreateLunaClient(Amazon.CloudHSM.Model.CreateLunaClientRequest)"> <summary> Creates an HSM client. </summary> <param name="request">Container for the necessary parameters to execute the CreateLunaClient service method.</param> <returns>The response from the CreateLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.CreateLunaClientAsync(Amazon.CloudHSM.Model.CreateLunaClientRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLunaClient operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLunaClient operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DeleteHapg(System.String)"> <summary> Deletes a high-availability partition group. </summary> <param name="hapgArn">The ARN of the high-availability partition group to delete.</param> <returns>The response from the DeleteHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DeleteHapg(Amazon.CloudHSM.Model.DeleteHapgRequest)"> <summary> Deletes a high-availability partition group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHapg service method.</param> <returns>The response from the DeleteHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DeleteHapgAsync(Amazon.CloudHSM.Model.DeleteHapgRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteHapg operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHapg operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DeleteHsm(System.String)"> <summary> Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered. </summary> <param name="hsmArn">The ARN of the HSM to delete.</param> <returns>The response from the DeleteHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DeleteHsm(Amazon.CloudHSM.Model.DeleteHsmRequest)"> <summary> Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHsm service method.</param> <returns>The response from the DeleteHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DeleteHsmAsync(Amazon.CloudHSM.Model.DeleteHsmRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteHsm operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHsm operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DeleteLunaClient(System.String)"> <summary> Deletes a client. </summary> <param name="clientArn">The ARN of the client to delete.</param> <returns>The response from the DeleteLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DeleteLunaClient(Amazon.CloudHSM.Model.DeleteLunaClientRequest)"> <summary> Deletes a client. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLunaClient service method.</param> <returns>The response from the DeleteLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DeleteLunaClientAsync(Amazon.CloudHSM.Model.DeleteLunaClientRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLunaClient operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLunaClient operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DescribeHapg(System.String)"> <summary> Retrieves information about a high-availability partition group. </summary> <param name="hapgArn">The ARN of the high-availability partition group to describe.</param> <returns>The response from the DescribeHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DescribeHapg(Amazon.CloudHSM.Model.DescribeHapgRequest)"> <summary> Retrieves information about a high-availability partition group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHapg service method.</param> <returns>The response from the DescribeHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DescribeHapgAsync(Amazon.CloudHSM.Model.DescribeHapgRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeHapg operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHapg operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DescribeHsm(System.String)"> <summary> Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number. </summary> <param name="hsmArn">The ARN of the HSM. Either the <i>HsmArn</i> or the <i>SerialNumber</i> parameter must be specified.</param> <returns>The response from the DescribeHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DescribeHsm(Amazon.CloudHSM.Model.DescribeHsmRequest)"> <summary> Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHsm service method.</param> <returns>The response from the DescribeHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DescribeHsmAsync(Amazon.CloudHSM.Model.DescribeHsmRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeHsm operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHsm operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DescribeLunaClient(Amazon.CloudHSM.Model.DescribeLunaClientRequest)"> <summary> Retrieves information about an HSM client. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLunaClient service method.</param> <returns>The response from the DescribeLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DescribeLunaClientAsync(Amazon.CloudHSM.Model.DescribeLunaClientRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLunaClient operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLunaClient operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.GetConfig(Amazon.CloudHSM.Model.GetConfigRequest)"> <summary> Gets the configuration files necessary to connect to all high availability partition groups the client is associated with. </summary> <param name="request">Container for the necessary parameters to execute the GetConfig service method.</param> <returns>The response from the GetConfig service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.GetConfigAsync(Amazon.CloudHSM.Model.GetConfigRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the GetConfig operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListAvailableZones"> <summary> Lists the Availability Zones that have available AWS CloudHSM capacity. </summary> <returns>The response from the ListAvailableZones service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListAvailableZones(Amazon.CloudHSM.Model.ListAvailableZonesRequest)"> <summary> Lists the Availability Zones that have available AWS CloudHSM capacity. </summary> <param name="request">Container for the necessary parameters to execute the ListAvailableZones service method.</param> <returns>The response from the ListAvailableZones service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListAvailableZonesAsync(Amazon.CloudHSM.Model.ListAvailableZonesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAvailableZones operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAvailableZones operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListHapgs"> <summary> Lists the high-availability partition groups for the account. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHapgs</a> to retrieve the next set of items. </para> </summary> <returns>The response from the ListHapgs service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListHapgs(Amazon.CloudHSM.Model.ListHapgsRequest)"> <summary> Lists the high-availability partition groups for the account. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHapgs</a> to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListHapgs service method.</param> <returns>The response from the ListHapgs service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListHapgsAsync(Amazon.CloudHSM.Model.ListHapgsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListHapgs operation. </summary> <param name="request">Container for the necessary parameters to execute the ListHapgs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListHsms"> <summary> Retrieves the identifiers of all of the HSMs provisioned for the current customer. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHsms</a> to retrieve the next set of items. </para> </summary> <returns>The response from the ListHsms service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListHsms(Amazon.CloudHSM.Model.ListHsmsRequest)"> <summary> Retrieves the identifiers of all of the HSMs provisioned for the current customer. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHsms</a> to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListHsms service method.</param> <returns>The response from the ListHsms service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListHsmsAsync(Amazon.CloudHSM.Model.ListHsmsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListHsms operation. </summary> <param name="request">Container for the necessary parameters to execute the ListHsms operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListLunaClients"> <summary> Lists all of the clients. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListLunaClients</a> to retrieve the next set of items. </para> </summary> <returns>The response from the ListLunaClients service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListLunaClients(Amazon.CloudHSM.Model.ListLunaClientsRequest)"> <summary> Lists all of the clients. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListLunaClients</a> to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListLunaClients service method.</param> <returns>The response from the ListLunaClients service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListLunaClientsAsync(Amazon.CloudHSM.Model.ListLunaClientsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListLunaClients operation. </summary> <param name="request">Container for the necessary parameters to execute the ListLunaClients operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ModifyHapg(Amazon.CloudHSM.Model.ModifyHapgRequest)"> <summary> Modifies an existing high-availability partition group. </summary> <param name="request">Container for the necessary parameters to execute the ModifyHapg service method.</param> <returns>The response from the ModifyHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ModifyHapgAsync(Amazon.CloudHSM.Model.ModifyHapgRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyHapg operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyHapg operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ModifyHsm(Amazon.CloudHSM.Model.ModifyHsmRequest)"> <summary> Modifies an HSM. </summary> <param name="request">Container for the necessary parameters to execute the ModifyHsm service method.</param> <returns>The response from the ModifyHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ModifyHsmAsync(Amazon.CloudHSM.Model.ModifyHsmRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyHsm operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyHsm operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ModifyLunaClient(Amazon.CloudHSM.Model.ModifyLunaClientRequest)"> <summary> Modifies the certificate used by the client. <para> This action can potentially start a workflow to install the new certificate on the client's HSMs. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyLunaClient service method.</param> <returns>The response from the ModifyLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ModifyLunaClientAsync(Amazon.CloudHSM.Model.ModifyLunaClientRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyLunaClient operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyLunaClient operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor"> <summary> Constructs AmazonCloudHSMClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudHSMClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(Amazon.CloudHSM.AmazonCloudHSMConfig)"> <summary> Constructs AmazonCloudHSMClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudHSMClient Configuration Object</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudHSMClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudHSMClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudHSM.AmazonCloudHSMConfig)"> <summary> Constructs AmazonCloudHSMClient with AWS Credentials and an AmazonCloudHSMClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudHSMClient Configuration Object</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudHSMClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudHSMClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(System.String,System.String,Amazon.CloudHSM.AmazonCloudHSMConfig)"> <summary> Constructs AmazonCloudHSMClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudHSMClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudHSMClient Configuration Object</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudHSMClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudHSMClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(System.String,System.String,System.String,Amazon.CloudHSM.AmazonCloudHSMConfig)"> <summary> Constructs AmazonCloudHSMClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudHSMClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudHSMClient Configuration Object</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.CreateHapg(System.String)"> <summary> Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs. </summary> <param name="label">The label of the new high-availability partition group.</param> <returns>The response from the CreateHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.CreateHapg(Amazon.CloudHSM.Model.CreateHapgRequest)"> <summary> Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs. </summary> <param name="request">Container for the necessary parameters to execute the CreateHapg service method.</param> <returns>The response from the CreateHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.CreateHapgAsync(Amazon.CloudHSM.Model.CreateHapgRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateHapg operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateHapg operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.CreateHsm(Amazon.CloudHSM.Model.CreateHsmRequest)"> <summary> Creates an uninitialized HSM instance. Running this command provisions an HSM appliance and will result in charges to your AWS account for the HSM. </summary> <param name="request">Container for the necessary parameters to execute the CreateHsm service method.</param> <returns>The response from the CreateHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.CreateHsmAsync(Amazon.CloudHSM.Model.CreateHsmRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateHsm operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateHsm operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.CreateLunaClient(Amazon.CloudHSM.Model.CreateLunaClientRequest)"> <summary> Creates an HSM client. </summary> <param name="request">Container for the necessary parameters to execute the CreateLunaClient service method.</param> <returns>The response from the CreateLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.CreateLunaClientAsync(Amazon.CloudHSM.Model.CreateLunaClientRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLunaClient operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLunaClient operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DeleteHapg(System.String)"> <summary> Deletes a high-availability partition group. </summary> <param name="hapgArn">The ARN of the high-availability partition group to delete.</param> <returns>The response from the DeleteHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DeleteHapg(Amazon.CloudHSM.Model.DeleteHapgRequest)"> <summary> Deletes a high-availability partition group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHapg service method.</param> <returns>The response from the DeleteHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DeleteHapgAsync(Amazon.CloudHSM.Model.DeleteHapgRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteHapg operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHapg operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DeleteHsm(System.String)"> <summary> Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered. </summary> <param name="hsmArn">The ARN of the HSM to delete.</param> <returns>The response from the DeleteHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DeleteHsm(Amazon.CloudHSM.Model.DeleteHsmRequest)"> <summary> Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHsm service method.</param> <returns>The response from the DeleteHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DeleteHsmAsync(Amazon.CloudHSM.Model.DeleteHsmRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteHsm operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHsm operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DeleteLunaClient(System.String)"> <summary> Deletes a client. </summary> <param name="clientArn">The ARN of the client to delete.</param> <returns>The response from the DeleteLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DeleteLunaClient(Amazon.CloudHSM.Model.DeleteLunaClientRequest)"> <summary> Deletes a client. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLunaClient service method.</param> <returns>The response from the DeleteLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DeleteLunaClientAsync(Amazon.CloudHSM.Model.DeleteLunaClientRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLunaClient operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLunaClient operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DescribeHapg(System.String)"> <summary> Retrieves information about a high-availability partition group. </summary> <param name="hapgArn">The ARN of the high-availability partition group to describe.</param> <returns>The response from the DescribeHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DescribeHapg(Amazon.CloudHSM.Model.DescribeHapgRequest)"> <summary> Retrieves information about a high-availability partition group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHapg service method.</param> <returns>The response from the DescribeHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DescribeHapgAsync(Amazon.CloudHSM.Model.DescribeHapgRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeHapg operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHapg operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DescribeHsm(System.String)"> <summary> Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number. </summary> <param name="hsmArn">The ARN of the HSM. Either the <i>HsmArn</i> or the <i>SerialNumber</i> parameter must be specified.</param> <returns>The response from the DescribeHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DescribeHsm(Amazon.CloudHSM.Model.DescribeHsmRequest)"> <summary> Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHsm service method.</param> <returns>The response from the DescribeHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DescribeHsmAsync(Amazon.CloudHSM.Model.DescribeHsmRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeHsm operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHsm operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DescribeLunaClient(Amazon.CloudHSM.Model.DescribeLunaClientRequest)"> <summary> Retrieves information about an HSM client. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLunaClient service method.</param> <returns>The response from the DescribeLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DescribeLunaClientAsync(Amazon.CloudHSM.Model.DescribeLunaClientRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLunaClient operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLunaClient operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.GetConfig(Amazon.CloudHSM.Model.GetConfigRequest)"> <summary> Gets the configuration files necessary to connect to all high availability partition groups the client is associated with. </summary> <param name="request">Container for the necessary parameters to execute the GetConfig service method.</param> <returns>The response from the GetConfig service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.GetConfigAsync(Amazon.CloudHSM.Model.GetConfigRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the GetConfig operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListAvailableZones"> <summary> Lists the Availability Zones that have available AWS CloudHSM capacity. </summary> <returns>The response from the ListAvailableZones service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListAvailableZones(Amazon.CloudHSM.Model.ListAvailableZonesRequest)"> <summary> Lists the Availability Zones that have available AWS CloudHSM capacity. </summary> <param name="request">Container for the necessary parameters to execute the ListAvailableZones service method.</param> <returns>The response from the ListAvailableZones service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListAvailableZonesAsync(Amazon.CloudHSM.Model.ListAvailableZonesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAvailableZones operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAvailableZones operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListHapgs"> <summary> Lists the high-availability partition groups for the account. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHapgs</a> to retrieve the next set of items. </para> </summary> <returns>The response from the ListHapgs service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListHapgs(Amazon.CloudHSM.Model.ListHapgsRequest)"> <summary> Lists the high-availability partition groups for the account. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHapgs</a> to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListHapgs service method.</param> <returns>The response from the ListHapgs service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListHapgsAsync(Amazon.CloudHSM.Model.ListHapgsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListHapgs operation. </summary> <param name="request">Container for the necessary parameters to execute the ListHapgs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListHsms"> <summary> Retrieves the identifiers of all of the HSMs provisioned for the current customer. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHsms</a> to retrieve the next set of items. </para> </summary> <returns>The response from the ListHsms service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListHsms(Amazon.CloudHSM.Model.ListHsmsRequest)"> <summary> Retrieves the identifiers of all of the HSMs provisioned for the current customer. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHsms</a> to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListHsms service method.</param> <returns>The response from the ListHsms service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListHsmsAsync(Amazon.CloudHSM.Model.ListHsmsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListHsms operation. </summary> <param name="request">Container for the necessary parameters to execute the ListHsms operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListLunaClients"> <summary> Lists all of the clients. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListLunaClients</a> to retrieve the next set of items. </para> </summary> <returns>The response from the ListLunaClients service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListLunaClients(Amazon.CloudHSM.Model.ListLunaClientsRequest)"> <summary> Lists all of the clients. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListLunaClients</a> to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListLunaClients service method.</param> <returns>The response from the ListLunaClients service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListLunaClientsAsync(Amazon.CloudHSM.Model.ListLunaClientsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListLunaClients operation. </summary> <param name="request">Container for the necessary parameters to execute the ListLunaClients operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ModifyHapg(Amazon.CloudHSM.Model.ModifyHapgRequest)"> <summary> Modifies an existing high-availability partition group. </summary> <param name="request">Container for the necessary parameters to execute the ModifyHapg service method.</param> <returns>The response from the ModifyHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ModifyHapgAsync(Amazon.CloudHSM.Model.ModifyHapgRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyHapg operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyHapg operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ModifyHsm(Amazon.CloudHSM.Model.ModifyHsmRequest)"> <summary> Modifies an HSM. </summary> <param name="request">Container for the necessary parameters to execute the ModifyHsm service method.</param> <returns>The response from the ModifyHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ModifyHsmAsync(Amazon.CloudHSM.Model.ModifyHsmRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyHsm operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyHsm operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ModifyLunaClient(Amazon.CloudHSM.Model.ModifyLunaClientRequest)"> <summary> Modifies the certificate used by the client. <para> This action can potentially start a workflow to install the new certificate on the client's HSMs. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyLunaClient service method.</param> <returns>The response from the ModifyLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ModifyLunaClientAsync(Amazon.CloudHSM.Model.ModifyLunaClientRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyLunaClient operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyLunaClient operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.CodeDeploy.AmazonCodeDeployClient"> <summary> Implementation for accessing CodeDeploy AWS CodeDeploy <b>Overview</b> <para> This is the AWS CodeDeploy API Reference. This guide provides descriptions of the AWS CodeDeploy APIs. For additional information, see the <a href="http://docs.aws.amazon.com/codedeploy/latest/userguide">AWS CodeDeploy User Guide</a>. </para> <b>Using the APIs</b> <para> You can use the AWS CodeDeploy APIs to work with the following items: </para> <ul> <li> <para> Applications are unique identifiers that AWS CodeDeploy uses to ensure that the correct combinations of revisions, deployment configurations, and deployment groups are being referenced during deployments. </para> <para> You can use the AWS CodeDeploy APIs to create, delete, get, list, and update applications. </para> </li> <li> <para> Deployment configurations are sets of deployment rules and deployment success and failure conditions that AWS CodeDeploy uses during deployments. </para> <para> You can use the AWS CodeDeploy APIs to create, delete, get, and list deployment configurations. </para> </li> <li> <para> Deployment groups are groups of instances to which application revisions can be deployed. </para> <para> You can use the AWS CodeDeploy APIs to create, delete, get, list, and update deployment groups. </para> </li> <li> <para> Instances represent Amazon EC2 instances to which application revisions are deployed. Instances are identified by their Amazon EC2 tags or Auto Scaling group names. Instances belong to deployment groups. </para> <para> You can use the AWS CodeDeploy APIs to get and list instances. </para> </li> <li> <para> Deployments represent the process of deploying revisions to instances. </para> <para> You can use the AWS CodeDeploy APIs to create, get, list, and stop deployments. </para> </li> <li> <para> Application revisions are archive files that are stored in Amazon S3 buckets or GitHub repositories. These revisions contain source content (such as source code, web pages, executable files, any deployment scripts, and similar) along with an Application Specification file (AppSpec file). (The AppSpec file is unique to AWS CodeDeploy; it defines a series of deployment actions that you want AWS CodeDeploy to execute.) An application revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both (for application revisions that are stored in Amazon S3 buckets) or by its repository name and commit ID (for applications revisions that are stored in GitHub repositories). Application revisions are deployed through deployment groups. </para> <para> You can use the AWS CodeDeploy APIs to get, list, and register application revisions. </para> </li> </ul> </summary> </member> <member name="T:Amazon.CodeDeploy.IAmazonCodeDeploy"> <summary> Interface for accessing CodeDeploy AWS CodeDeploy <b>Overview</b> <para> This is the AWS CodeDeploy API Reference. This guide provides descriptions of the AWS CodeDeploy APIs. For additional information, see the <a href="http://docs.aws.amazon.com/codedeploy/latest/userguide">AWS CodeDeploy User Guide</a>. </para> <b>Using the APIs</b> <para> You can use the AWS CodeDeploy APIs to work with the following items: </para> <ul> <li> <para> Applications are unique identifiers that AWS CodeDeploy uses to ensure that the correct combinations of revisions, deployment configurations, and deployment groups are being referenced during deployments. </para> <para> You can use the AWS CodeDeploy APIs to create, delete, get, list, and update applications. </para> </li> <li> <para> Deployment configurations are sets of deployment rules and deployment success and failure conditions that AWS CodeDeploy uses during deployments. </para> <para> You can use the AWS CodeDeploy APIs to create, delete, get, and list deployment configurations. </para> </li> <li> <para> Deployment groups are groups of instances to which application revisions can be deployed. </para> <para> You can use the AWS CodeDeploy APIs to create, delete, get, list, and update deployment groups. </para> </li> <li> <para> Instances represent Amazon EC2 instances to which application revisions are deployed. Instances are identified by their Amazon EC2 tags or Auto Scaling group names. Instances belong to deployment groups. </para> <para> You can use the AWS CodeDeploy APIs to get and list instances. </para> </li> <li> <para> Deployments represent the process of deploying revisions to instances. </para> <para> You can use the AWS CodeDeploy APIs to create, get, list, and stop deployments. </para> </li> <li> <para> Application revisions are archive files that are stored in Amazon S3 buckets or GitHub repositories. These revisions contain source content (such as source code, web pages, executable files, any deployment scripts, and similar) along with an Application Specification file (AppSpec file). (The AppSpec file is unique to AWS CodeDeploy; it defines a series of deployment actions that you want AWS CodeDeploy to execute.) An application revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both (for application revisions that are stored in Amazon S3 buckets) or by its repository name and commit ID (for applications revisions that are stored in GitHub repositories). Application revisions are deployed through deployment groups. </para> <para> You can use the AWS CodeDeploy APIs to get, list, and register application revisions. </para> </li> </ul> </summary> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.AddTagsToOnPremisesInstances(Amazon.CodeDeploy.Model.AddTagsToOnPremisesInstancesRequest)"> <summary> Adds tags to on-premises instances. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToOnPremisesInstances service method.</param> <returns>The response from the AddTagsToOnPremisesInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InstanceLimitExceededException"> The maximum number of allowed on-premises instances in a single call was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNotRegisteredException"> The specified on-premises instance is not registered. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagException"> The specified tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TagLimitExceededException"> The maximum allowed number of tags was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TagRequiredException"> A tag was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.AddTagsToOnPremisesInstancesAsync(Amazon.CodeDeploy.Model.AddTagsToOnPremisesInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTagsToOnPremisesInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToOnPremisesInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BatchGetApplicationRevisions(Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsRequest)"> <summary> Gets information about one or more application revisions. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetApplicationRevisions service method.</param> <returns>The response from the BatchGetApplicationRevisions service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> The revision was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> The revision ID was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BatchGetApplicationRevisionsAsync(Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchGetApplicationRevisions operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetApplicationRevisions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BatchGetApplications(Amazon.CodeDeploy.Model.BatchGetApplicationsRequest)"> <summary> Gets information about one or more applications. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetApplications service method.</param> <returns>The response from the BatchGetApplications service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BatchGetApplicationsAsync(Amazon.CodeDeploy.Model.BatchGetApplicationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchGetApplications operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetApplications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BatchGetDeploymentInstances(Amazon.CodeDeploy.Model.BatchGetDeploymentInstancesRequest)"> <summary> Gets information about one or more instances that are part of a deployment group. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetDeploymentInstances service method.</param> <returns>The response from the BatchGetDeploymentInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceIdRequiredException"> The instance ID was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BatchGetDeploymentInstancesAsync(Amazon.CodeDeploy.Model.BatchGetDeploymentInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchGetDeploymentInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetDeploymentInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BatchGetDeployments(Amazon.CodeDeploy.Model.BatchGetDeploymentsRequest)"> <summary> Gets information about one or more deployments. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetDeployments service method.</param> <returns>The response from the BatchGetDeployments service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BatchGetDeploymentsAsync(Amazon.CodeDeploy.Model.BatchGetDeploymentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchGetDeployments operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetDeployments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BatchGetOnPremisesInstances(Amazon.CodeDeploy.Model.BatchGetOnPremisesInstancesRequest)"> <summary> Gets information about one or more on-premises instances. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetOnPremisesInstances service method.</param> <returns>The response from the BatchGetOnPremisesInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BatchGetOnPremisesInstancesAsync(Amazon.CodeDeploy.Model.BatchGetOnPremisesInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchGetOnPremisesInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetOnPremisesInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.CreateApplication(Amazon.CodeDeploy.Model.CreateApplicationRequest)"> <summary> Creates a new application. </summary> <param name="request">Container for the necessary parameters to execute the CreateApplication service method.</param> <returns>The response from the CreateApplication service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationAlreadyExistsException"> An application with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationLimitExceededException"> More applications were attempted to be created than were allowed. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.CreateApplicationAsync(Amazon.CodeDeploy.Model.CreateApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.CreateDeployment(Amazon.CodeDeploy.Model.CreateDeploymentRequest)"> <summary> Deploys an application revision through the specified deployment group. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeployment service method.</param> <returns>The response from the CreateDeployment service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> The deployment configuration does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> The named deployment group does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentLimitExceededException"> The number of allowed deployments was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DescriptionTooLongException"> The description that was provided is too long. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> The revision was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> The revision ID was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.CreateDeploymentAsync(Amazon.CodeDeploy.Model.CreateDeploymentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDeployment operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeployment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.CreateDeploymentConfig(Amazon.CodeDeploy.Model.CreateDeploymentConfigRequest)"> <summary> Creates a new deployment configuration. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeploymentConfig service method.</param> <returns>The response from the CreateDeploymentConfig service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigAlreadyExistsException"> A deployment configuration with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigLimitExceededException"> The deployment configurations limit was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigNameRequiredException"> The deployment configuration name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidMinimumHealthyHostValueException"> The minimum healthy instances value was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.CreateDeploymentConfigAsync(Amazon.CodeDeploy.Model.CreateDeploymentConfigRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDeploymentConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeploymentConfig operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.CreateDeploymentGroup(Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest)"> <summary> Creates a new deployment group for application revisions to be deployed to. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeploymentGroup service method.</param> <returns>The response from the CreateDeploymentGroup service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> The deployment configuration does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupAlreadyExistsException"> A deployment group with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupLimitExceededException"> The deployment groups limit was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidAutoScalingGroupException"> The Auto Scaling group was specified in an invalid format or does not exist. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidEC2TagException"> The tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRoleException"> The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagException"> The specified tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTriggerConfigException"> The trigger was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.LifecycleHookLimitExceededException"> The limit for lifecycle hooks was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RoleRequiredException"> The role ID was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TriggerTargetsLimitExceededException"> The maximum allowed number of triggers was exceeded. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.CreateDeploymentGroupAsync(Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDeploymentGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeploymentGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.DeleteApplication(Amazon.CodeDeploy.Model.DeleteApplicationRequest)"> <summary> Deletes an application. </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplication service method.</param> <returns>The response from the DeleteApplication service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.DeleteApplicationAsync(Amazon.CodeDeploy.Model.DeleteApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.DeleteDeploymentConfig(Amazon.CodeDeploy.Model.DeleteDeploymentConfigRequest)"> <summary> Deletes a deployment configuration. <note>A deployment configuration cannot be deleted if it is currently in use. Also, predefined configurations cannot be deleted.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeploymentConfig service method.</param> <returns>The response from the DeleteDeploymentConfig service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigInUseException"> The deployment configuration is still in use. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigNameRequiredException"> The deployment configuration name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidOperationException"> An invalid operation was detected. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.DeleteDeploymentConfigAsync(Amazon.CodeDeploy.Model.DeleteDeploymentConfigRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDeploymentConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeploymentConfig operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.DeleteDeploymentGroup(Amazon.CodeDeploy.Model.DeleteDeploymentGroupRequest)"> <summary> Deletes a deployment group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeploymentGroup service method.</param> <returns>The response from the DeleteDeploymentGroup service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRoleException"> The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.DeleteDeploymentGroupAsync(Amazon.CodeDeploy.Model.DeleteDeploymentGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDeploymentGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeploymentGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.DeregisterOnPremisesInstance(Amazon.CodeDeploy.Model.DeregisterOnPremisesInstanceRequest)"> <summary> Deregisters an on-premises instance. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterOnPremisesInstance service method.</param> <returns>The response from the DeregisterOnPremisesInstance service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.DeregisterOnPremisesInstanceAsync(Amazon.CodeDeploy.Model.DeregisterOnPremisesInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterOnPremisesInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterOnPremisesInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetApplication(Amazon.CodeDeploy.Model.GetApplicationRequest)"> <summary> Gets information about an application. </summary> <param name="request">Container for the necessary parameters to execute the GetApplication service method.</param> <returns>The response from the GetApplication service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetApplicationAsync(Amazon.CodeDeploy.Model.GetApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the GetApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetApplicationRevision(Amazon.CodeDeploy.Model.GetApplicationRevisionRequest)"> <summary> Gets information about an application revision. </summary> <param name="request">Container for the necessary parameters to execute the GetApplicationRevision service method.</param> <returns>The response from the GetApplicationRevision service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> The revision was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionDoesNotExistException"> The named revision does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> The revision ID was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetApplicationRevisionAsync(Amazon.CodeDeploy.Model.GetApplicationRevisionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetApplicationRevision operation. </summary> <param name="request">Container for the necessary parameters to execute the GetApplicationRevision operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetDeployment(Amazon.CodeDeploy.Model.GetDeploymentRequest)"> <summary> Gets information about a deployment. </summary> <param name="request">Container for the necessary parameters to execute the GetDeployment service method.</param> <returns>The response from the GetDeployment service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetDeploymentAsync(Amazon.CodeDeploy.Model.GetDeploymentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDeployment operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDeployment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetDeploymentConfig(Amazon.CodeDeploy.Model.GetDeploymentConfigRequest)"> <summary> Gets information about a deployment configuration. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentConfig service method.</param> <returns>The response from the GetDeploymentConfig service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> The deployment configuration does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigNameRequiredException"> The deployment configuration name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetDeploymentConfigAsync(Amazon.CodeDeploy.Model.GetDeploymentConfigRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDeploymentConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentConfig operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetDeploymentGroup(Amazon.CodeDeploy.Model.GetDeploymentGroupRequest)"> <summary> Gets information about a deployment group. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentGroup service method.</param> <returns>The response from the GetDeploymentGroup service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> The named deployment group does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetDeploymentGroupAsync(Amazon.CodeDeploy.Model.GetDeploymentGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDeploymentGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetDeploymentInstance(Amazon.CodeDeploy.Model.GetDeploymentInstanceRequest)"> <summary> Gets information about an instance as part of a deployment. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentInstance service method.</param> <returns>The response from the GetDeploymentInstance service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceDoesNotExistException"> The specified instance does not exist in the deployment group. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceIdRequiredException"> The instance ID was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetDeploymentInstanceAsync(Amazon.CodeDeploy.Model.GetDeploymentInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDeploymentInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetOnPremisesInstance(Amazon.CodeDeploy.Model.GetOnPremisesInstanceRequest)"> <summary> Gets information about an on-premises instance. </summary> <param name="request">Container for the necessary parameters to execute the GetOnPremisesInstance service method.</param> <returns>The response from the GetOnPremisesInstance service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNotRegisteredException"> The specified on-premises instance is not registered. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetOnPremisesInstanceAsync(Amazon.CodeDeploy.Model.GetOnPremisesInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetOnPremisesInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the GetOnPremisesInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListApplicationRevisions(Amazon.CodeDeploy.Model.ListApplicationRevisionsRequest)"> <summary> Lists information about revisions for an application. </summary> <param name="request">Container for the necessary parameters to execute the ListApplicationRevisions service method.</param> <returns>The response from the ListApplicationRevisions service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.BucketNameFilterRequiredException"> A bucket name is required but was not provided. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidBucketNameFilterException"> The bucket name either doesn't exist or was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeployedStateFilterException"> The deployed state filter was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidKeyPrefixFilterException"> The specified key prefix filter was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidSortByException"> The column name to sort by is either not present or was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidSortOrderException"> The sort order was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListApplicationRevisionsAsync(Amazon.CodeDeploy.Model.ListApplicationRevisionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListApplicationRevisions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListApplicationRevisions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListApplications"> <summary> Lists the applications registered with the applicable IAM user or AWS account. </summary> <returns>The response from the ListApplications service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListApplications(Amazon.CodeDeploy.Model.ListApplicationsRequest)"> <summary> Lists the applications registered with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListApplications service method.</param> <returns>The response from the ListApplications service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListApplicationsAsync(Amazon.CodeDeploy.Model.ListApplicationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListApplications operation. </summary> <param name="request">Container for the necessary parameters to execute the ListApplications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListDeploymentConfigs"> <summary> Lists the deployment configurations with the applicable IAM user or AWS account. </summary> <returns>The response from the ListDeploymentConfigs service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListDeploymentConfigs(Amazon.CodeDeploy.Model.ListDeploymentConfigsRequest)"> <summary> Lists the deployment configurations with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentConfigs service method.</param> <returns>The response from the ListDeploymentConfigs service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListDeploymentConfigsAsync(Amazon.CodeDeploy.Model.ListDeploymentConfigsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDeploymentConfigs operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentConfigs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListDeploymentGroups(Amazon.CodeDeploy.Model.ListDeploymentGroupsRequest)"> <summary> Lists the deployment groups for an application registered with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentGroups service method.</param> <returns>The response from the ListDeploymentGroups service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListDeploymentGroupsAsync(Amazon.CodeDeploy.Model.ListDeploymentGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDeploymentGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListDeploymentInstances(Amazon.CodeDeploy.Model.ListDeploymentInstancesRequest)"> <summary> Lists the instances for a deployment associated with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentInstances service method.</param> <returns>The response from the ListDeploymentInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentNotStartedException"> The specified deployment has not started. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceStatusException"> The specified instance status does not exist. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListDeploymentInstancesAsync(Amazon.CodeDeploy.Model.ListDeploymentInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDeploymentInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListDeployments(Amazon.CodeDeploy.Model.ListDeploymentsRequest)"> <summary> Lists the deployments within a deployment group for an application registered with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDeployments service method.</param> <returns>The response from the ListDeployments service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> The named deployment group does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentStatusException"> The specified deployment status doesn't exist or cannot be determined. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTimeRangeException"> The specified time range was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListDeploymentsAsync(Amazon.CodeDeploy.Model.ListDeploymentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDeployments operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeployments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListOnPremisesInstances(Amazon.CodeDeploy.Model.ListOnPremisesInstancesRequest)"> <summary> Gets a list of one or more on-premises instance names. <para> Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListOnPremisesInstances service method.</param> <returns>The response from the ListOnPremisesInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRegistrationStatusException"> The registration status was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagFilterException"> The specified tag filter was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListOnPremisesInstancesAsync(Amazon.CodeDeploy.Model.ListOnPremisesInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListOnPremisesInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ListOnPremisesInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.RegisterApplicationRevision(Amazon.CodeDeploy.Model.RegisterApplicationRevisionRequest)"> <summary> Registers with AWS CodeDeploy a revision for the specified application. </summary> <param name="request">Container for the necessary parameters to execute the RegisterApplicationRevision service method.</param> <returns>The response from the RegisterApplicationRevision service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DescriptionTooLongException"> The description that was provided is too long. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> The revision was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> The revision ID was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.RegisterApplicationRevisionAsync(Amazon.CodeDeploy.Model.RegisterApplicationRevisionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterApplicationRevision operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterApplicationRevision operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.RegisterOnPremisesInstance(Amazon.CodeDeploy.Model.RegisterOnPremisesInstanceRequest)"> <summary> Registers an on-premises instance. </summary> <param name="request">Container for the necessary parameters to execute the RegisterOnPremisesInstance service method.</param> <returns>The response from the RegisterOnPremisesInstance service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.IamUserArnAlreadyRegisteredException"> The specified IAM user ARN is already registered with an on-premises instance. </exception> <exception cref="T:Amazon.CodeDeploy.Model.IamUserArnRequiredException"> An IAM user ARN was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameAlreadyRegisteredException"> The specified on-premises instance name is already registered. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidIamUserArnException"> The IAM user ARN was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.RegisterOnPremisesInstanceAsync(Amazon.CodeDeploy.Model.RegisterOnPremisesInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterOnPremisesInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterOnPremisesInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.RemoveTagsFromOnPremisesInstances(Amazon.CodeDeploy.Model.RemoveTagsFromOnPremisesInstancesRequest)"> <summary> Removes one or more tags from one or more on-premises instances. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromOnPremisesInstances service method.</param> <returns>The response from the RemoveTagsFromOnPremisesInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InstanceLimitExceededException"> The maximum number of allowed on-premises instances in a single call was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNotRegisteredException"> The specified on-premises instance is not registered. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagException"> The specified tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TagLimitExceededException"> The maximum allowed number of tags was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TagRequiredException"> A tag was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.RemoveTagsFromOnPremisesInstancesAsync(Amazon.CodeDeploy.Model.RemoveTagsFromOnPremisesInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTagsFromOnPremisesInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromOnPremisesInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.StopDeployment(Amazon.CodeDeploy.Model.StopDeploymentRequest)"> <summary> Attempts to stop an ongoing deployment. </summary> <param name="request">Container for the necessary parameters to execute the StopDeployment service method.</param> <returns>The response from the StopDeployment service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentAlreadyCompletedException"> The deployment is already completed. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.StopDeploymentAsync(Amazon.CodeDeploy.Model.StopDeploymentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StopDeployment operation. </summary> <param name="request">Container for the necessary parameters to execute the StopDeployment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.UpdateApplication(Amazon.CodeDeploy.Model.UpdateApplicationRequest)"> <summary> Changes an existing application's name. </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplication service method.</param> <returns>The response from the UpdateApplication service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationAlreadyExistsException"> An application with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.UpdateApplicationAsync(Amazon.CodeDeploy.Model.UpdateApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.UpdateDeploymentGroup(Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest)"> <summary> Changes information about an existing deployment group. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDeploymentGroup service method.</param> <returns>The response from the UpdateDeploymentGroup service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> The deployment configuration does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupAlreadyExistsException"> A deployment group with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> The named deployment group does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidAutoScalingGroupException"> The Auto Scaling group was specified in an invalid format or does not exist. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidEC2TagException"> The tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRoleException"> The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagException"> The specified tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTriggerConfigException"> The trigger was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.LifecycleHookLimitExceededException"> The limit for lifecycle hooks was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TriggerTargetsLimitExceededException"> The maximum allowed number of triggers was exceeded. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.UpdateDeploymentGroupAsync(Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDeploymentGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDeploymentGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor"> <summary> Constructs AmazonCodeDeployClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodeDeployClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(Amazon.CodeDeploy.AmazonCodeDeployConfig)"> <summary> Constructs AmazonCodeDeployClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCodeDeployClient Configuration Object</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCodeDeployClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodeDeployClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CodeDeploy.AmazonCodeDeployConfig)"> <summary> Constructs AmazonCodeDeployClient with AWS Credentials and an AmazonCodeDeployClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCodeDeployClient Configuration Object</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCodeDeployClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodeDeployClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(System.String,System.String,Amazon.CodeDeploy.AmazonCodeDeployConfig)"> <summary> Constructs AmazonCodeDeployClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeDeployClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCodeDeployClient Configuration Object</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCodeDeployClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodeDeployClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(System.String,System.String,System.String,Amazon.CodeDeploy.AmazonCodeDeployConfig)"> <summary> Constructs AmazonCodeDeployClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeDeployClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCodeDeployClient Configuration Object</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.AddTagsToOnPremisesInstances(Amazon.CodeDeploy.Model.AddTagsToOnPremisesInstancesRequest)"> <summary> Adds tags to on-premises instances. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToOnPremisesInstances service method.</param> <returns>The response from the AddTagsToOnPremisesInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InstanceLimitExceededException"> The maximum number of allowed on-premises instances in a single call was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNotRegisteredException"> The specified on-premises instance is not registered. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagException"> The specified tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TagLimitExceededException"> The maximum allowed number of tags was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TagRequiredException"> A tag was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.AddTagsToOnPremisesInstancesAsync(Amazon.CodeDeploy.Model.AddTagsToOnPremisesInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTagsToOnPremisesInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToOnPremisesInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BatchGetApplicationRevisions(Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsRequest)"> <summary> Gets information about one or more application revisions. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetApplicationRevisions service method.</param> <returns>The response from the BatchGetApplicationRevisions service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> The revision was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> The revision ID was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BatchGetApplicationRevisionsAsync(Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchGetApplicationRevisions operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetApplicationRevisions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BatchGetApplications(Amazon.CodeDeploy.Model.BatchGetApplicationsRequest)"> <summary> Gets information about one or more applications. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetApplications service method.</param> <returns>The response from the BatchGetApplications service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BatchGetApplicationsAsync(Amazon.CodeDeploy.Model.BatchGetApplicationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchGetApplications operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetApplications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BatchGetDeploymentInstances(Amazon.CodeDeploy.Model.BatchGetDeploymentInstancesRequest)"> <summary> Gets information about one or more instances that are part of a deployment group. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetDeploymentInstances service method.</param> <returns>The response from the BatchGetDeploymentInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceIdRequiredException"> The instance ID was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BatchGetDeploymentInstancesAsync(Amazon.CodeDeploy.Model.BatchGetDeploymentInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchGetDeploymentInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetDeploymentInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BatchGetDeployments(Amazon.CodeDeploy.Model.BatchGetDeploymentsRequest)"> <summary> Gets information about one or more deployments. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetDeployments service method.</param> <returns>The response from the BatchGetDeployments service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BatchGetDeploymentsAsync(Amazon.CodeDeploy.Model.BatchGetDeploymentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchGetDeployments operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetDeployments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BatchGetOnPremisesInstances(Amazon.CodeDeploy.Model.BatchGetOnPremisesInstancesRequest)"> <summary> Gets information about one or more on-premises instances. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetOnPremisesInstances service method.</param> <returns>The response from the BatchGetOnPremisesInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BatchGetOnPremisesInstancesAsync(Amazon.CodeDeploy.Model.BatchGetOnPremisesInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchGetOnPremisesInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetOnPremisesInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.CreateApplication(Amazon.CodeDeploy.Model.CreateApplicationRequest)"> <summary> Creates a new application. </summary> <param name="request">Container for the necessary parameters to execute the CreateApplication service method.</param> <returns>The response from the CreateApplication service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationAlreadyExistsException"> An application with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationLimitExceededException"> More applications were attempted to be created than were allowed. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.CreateApplicationAsync(Amazon.CodeDeploy.Model.CreateApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.CreateDeployment(Amazon.CodeDeploy.Model.CreateDeploymentRequest)"> <summary> Deploys an application revision through the specified deployment group. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeployment service method.</param> <returns>The response from the CreateDeployment service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> The deployment configuration does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> The named deployment group does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentLimitExceededException"> The number of allowed deployments was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DescriptionTooLongException"> The description that was provided is too long. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> The revision was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> The revision ID was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.CreateDeploymentAsync(Amazon.CodeDeploy.Model.CreateDeploymentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDeployment operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeployment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.CreateDeploymentConfig(Amazon.CodeDeploy.Model.CreateDeploymentConfigRequest)"> <summary> Creates a new deployment configuration. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeploymentConfig service method.</param> <returns>The response from the CreateDeploymentConfig service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigAlreadyExistsException"> A deployment configuration with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigLimitExceededException"> The deployment configurations limit was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigNameRequiredException"> The deployment configuration name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidMinimumHealthyHostValueException"> The minimum healthy instances value was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.CreateDeploymentConfigAsync(Amazon.CodeDeploy.Model.CreateDeploymentConfigRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDeploymentConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeploymentConfig operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.CreateDeploymentGroup(Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest)"> <summary> Creates a new deployment group for application revisions to be deployed to. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeploymentGroup service method.</param> <returns>The response from the CreateDeploymentGroup service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> The deployment configuration does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupAlreadyExistsException"> A deployment group with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupLimitExceededException"> The deployment groups limit was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidAutoScalingGroupException"> The Auto Scaling group was specified in an invalid format or does not exist. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidEC2TagException"> The tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRoleException"> The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagException"> The specified tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTriggerConfigException"> The trigger was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.LifecycleHookLimitExceededException"> The limit for lifecycle hooks was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RoleRequiredException"> The role ID was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TriggerTargetsLimitExceededException"> The maximum allowed number of triggers was exceeded. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.CreateDeploymentGroupAsync(Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDeploymentGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeploymentGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.DeleteApplication(Amazon.CodeDeploy.Model.DeleteApplicationRequest)"> <summary> Deletes an application. </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplication service method.</param> <returns>The response from the DeleteApplication service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.DeleteApplicationAsync(Amazon.CodeDeploy.Model.DeleteApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.DeleteDeploymentConfig(Amazon.CodeDeploy.Model.DeleteDeploymentConfigRequest)"> <summary> Deletes a deployment configuration. <note>A deployment configuration cannot be deleted if it is currently in use. Also, predefined configurations cannot be deleted.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeploymentConfig service method.</param> <returns>The response from the DeleteDeploymentConfig service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigInUseException"> The deployment configuration is still in use. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigNameRequiredException"> The deployment configuration name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidOperationException"> An invalid operation was detected. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.DeleteDeploymentConfigAsync(Amazon.CodeDeploy.Model.DeleteDeploymentConfigRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDeploymentConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeploymentConfig operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.DeleteDeploymentGroup(Amazon.CodeDeploy.Model.DeleteDeploymentGroupRequest)"> <summary> Deletes a deployment group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeploymentGroup service method.</param> <returns>The response from the DeleteDeploymentGroup service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRoleException"> The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.DeleteDeploymentGroupAsync(Amazon.CodeDeploy.Model.DeleteDeploymentGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDeploymentGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeploymentGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.DeregisterOnPremisesInstance(Amazon.CodeDeploy.Model.DeregisterOnPremisesInstanceRequest)"> <summary> Deregisters an on-premises instance. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterOnPremisesInstance service method.</param> <returns>The response from the DeregisterOnPremisesInstance service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.DeregisterOnPremisesInstanceAsync(Amazon.CodeDeploy.Model.DeregisterOnPremisesInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterOnPremisesInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterOnPremisesInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetApplication(Amazon.CodeDeploy.Model.GetApplicationRequest)"> <summary> Gets information about an application. </summary> <param name="request">Container for the necessary parameters to execute the GetApplication service method.</param> <returns>The response from the GetApplication service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetApplicationAsync(Amazon.CodeDeploy.Model.GetApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the GetApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetApplicationRevision(Amazon.CodeDeploy.Model.GetApplicationRevisionRequest)"> <summary> Gets information about an application revision. </summary> <param name="request">Container for the necessary parameters to execute the GetApplicationRevision service method.</param> <returns>The response from the GetApplicationRevision service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> The revision was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionDoesNotExistException"> The named revision does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> The revision ID was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetApplicationRevisionAsync(Amazon.CodeDeploy.Model.GetApplicationRevisionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetApplicationRevision operation. </summary> <param name="request">Container for the necessary parameters to execute the GetApplicationRevision operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetDeployment(Amazon.CodeDeploy.Model.GetDeploymentRequest)"> <summary> Gets information about a deployment. </summary> <param name="request">Container for the necessary parameters to execute the GetDeployment service method.</param> <returns>The response from the GetDeployment service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetDeploymentAsync(Amazon.CodeDeploy.Model.GetDeploymentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDeployment operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDeployment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetDeploymentConfig(Amazon.CodeDeploy.Model.GetDeploymentConfigRequest)"> <summary> Gets information about a deployment configuration. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentConfig service method.</param> <returns>The response from the GetDeploymentConfig service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> The deployment configuration does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigNameRequiredException"> The deployment configuration name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetDeploymentConfigAsync(Amazon.CodeDeploy.Model.GetDeploymentConfigRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDeploymentConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentConfig operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetDeploymentGroup(Amazon.CodeDeploy.Model.GetDeploymentGroupRequest)"> <summary> Gets information about a deployment group. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentGroup service method.</param> <returns>The response from the GetDeploymentGroup service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> The named deployment group does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetDeploymentGroupAsync(Amazon.CodeDeploy.Model.GetDeploymentGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDeploymentGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetDeploymentInstance(Amazon.CodeDeploy.Model.GetDeploymentInstanceRequest)"> <summary> Gets information about an instance as part of a deployment. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentInstance service method.</param> <returns>The response from the GetDeploymentInstance service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceDoesNotExistException"> The specified instance does not exist in the deployment group. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceIdRequiredException"> The instance ID was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetDeploymentInstanceAsync(Amazon.CodeDeploy.Model.GetDeploymentInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDeploymentInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetOnPremisesInstance(Amazon.CodeDeploy.Model.GetOnPremisesInstanceRequest)"> <summary> Gets information about an on-premises instance. </summary> <param name="request">Container for the necessary parameters to execute the GetOnPremisesInstance service method.</param> <returns>The response from the GetOnPremisesInstance service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNotRegisteredException"> The specified on-premises instance is not registered. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetOnPremisesInstanceAsync(Amazon.CodeDeploy.Model.GetOnPremisesInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetOnPremisesInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the GetOnPremisesInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListApplicationRevisions(Amazon.CodeDeploy.Model.ListApplicationRevisionsRequest)"> <summary> Lists information about revisions for an application. </summary> <param name="request">Container for the necessary parameters to execute the ListApplicationRevisions service method.</param> <returns>The response from the ListApplicationRevisions service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.BucketNameFilterRequiredException"> A bucket name is required but was not provided. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidBucketNameFilterException"> The bucket name either doesn't exist or was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeployedStateFilterException"> The deployed state filter was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidKeyPrefixFilterException"> The specified key prefix filter was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidSortByException"> The column name to sort by is either not present or was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidSortOrderException"> The sort order was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListApplicationRevisionsAsync(Amazon.CodeDeploy.Model.ListApplicationRevisionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListApplicationRevisions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListApplicationRevisions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListApplications"> <summary> Lists the applications registered with the applicable IAM user or AWS account. </summary> <returns>The response from the ListApplications service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListApplications(Amazon.CodeDeploy.Model.ListApplicationsRequest)"> <summary> Lists the applications registered with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListApplications service method.</param> <returns>The response from the ListApplications service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListApplicationsAsync(Amazon.CodeDeploy.Model.ListApplicationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListApplications operation. </summary> <param name="request">Container for the necessary parameters to execute the ListApplications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListDeploymentConfigs"> <summary> Lists the deployment configurations with the applicable IAM user or AWS account. </summary> <returns>The response from the ListDeploymentConfigs service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListDeploymentConfigs(Amazon.CodeDeploy.Model.ListDeploymentConfigsRequest)"> <summary> Lists the deployment configurations with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentConfigs service method.</param> <returns>The response from the ListDeploymentConfigs service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListDeploymentConfigsAsync(Amazon.CodeDeploy.Model.ListDeploymentConfigsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDeploymentConfigs operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentConfigs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListDeploymentGroups(Amazon.CodeDeploy.Model.ListDeploymentGroupsRequest)"> <summary> Lists the deployment groups for an application registered with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentGroups service method.</param> <returns>The response from the ListDeploymentGroups service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListDeploymentGroupsAsync(Amazon.CodeDeploy.Model.ListDeploymentGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDeploymentGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListDeploymentInstances(Amazon.CodeDeploy.Model.ListDeploymentInstancesRequest)"> <summary> Lists the instances for a deployment associated with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentInstances service method.</param> <returns>The response from the ListDeploymentInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentNotStartedException"> The specified deployment has not started. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceStatusException"> The specified instance status does not exist. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListDeploymentInstancesAsync(Amazon.CodeDeploy.Model.ListDeploymentInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDeploymentInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListDeployments(Amazon.CodeDeploy.Model.ListDeploymentsRequest)"> <summary> Lists the deployments within a deployment group for an application registered with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDeployments service method.</param> <returns>The response from the ListDeployments service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> The named deployment group does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentStatusException"> The specified deployment status doesn't exist or cannot be determined. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTimeRangeException"> The specified time range was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListDeploymentsAsync(Amazon.CodeDeploy.Model.ListDeploymentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDeployments operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeployments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListOnPremisesInstances(Amazon.CodeDeploy.Model.ListOnPremisesInstancesRequest)"> <summary> Gets a list of one or more on-premises instance names. <para> Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListOnPremisesInstances service method.</param> <returns>The response from the ListOnPremisesInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRegistrationStatusException"> The registration status was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagFilterException"> The specified tag filter was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListOnPremisesInstancesAsync(Amazon.CodeDeploy.Model.ListOnPremisesInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListOnPremisesInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ListOnPremisesInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.RegisterApplicationRevision(Amazon.CodeDeploy.Model.RegisterApplicationRevisionRequest)"> <summary> Registers with AWS CodeDeploy a revision for the specified application. </summary> <param name="request">Container for the necessary parameters to execute the RegisterApplicationRevision service method.</param> <returns>The response from the RegisterApplicationRevision service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DescriptionTooLongException"> The description that was provided is too long. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> The revision was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> The revision ID was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.RegisterApplicationRevisionAsync(Amazon.CodeDeploy.Model.RegisterApplicationRevisionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterApplicationRevision operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterApplicationRevision operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.RegisterOnPremisesInstance(Amazon.CodeDeploy.Model.RegisterOnPremisesInstanceRequest)"> <summary> Registers an on-premises instance. </summary> <param name="request">Container for the necessary parameters to execute the RegisterOnPremisesInstance service method.</param> <returns>The response from the RegisterOnPremisesInstance service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.IamUserArnAlreadyRegisteredException"> The specified IAM user ARN is already registered with an on-premises instance. </exception> <exception cref="T:Amazon.CodeDeploy.Model.IamUserArnRequiredException"> An IAM user ARN was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameAlreadyRegisteredException"> The specified on-premises instance name is already registered. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidIamUserArnException"> The IAM user ARN was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.RegisterOnPremisesInstanceAsync(Amazon.CodeDeploy.Model.RegisterOnPremisesInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterOnPremisesInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterOnPremisesInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.RemoveTagsFromOnPremisesInstances(Amazon.CodeDeploy.Model.RemoveTagsFromOnPremisesInstancesRequest)"> <summary> Removes one or more tags from one or more on-premises instances. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromOnPremisesInstances service method.</param> <returns>The response from the RemoveTagsFromOnPremisesInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InstanceLimitExceededException"> The maximum number of allowed on-premises instances in a single call was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNotRegisteredException"> The specified on-premises instance is not registered. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagException"> The specified tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TagLimitExceededException"> The maximum allowed number of tags was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TagRequiredException"> A tag was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.RemoveTagsFromOnPremisesInstancesAsync(Amazon.CodeDeploy.Model.RemoveTagsFromOnPremisesInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTagsFromOnPremisesInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromOnPremisesInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.StopDeployment(Amazon.CodeDeploy.Model.StopDeploymentRequest)"> <summary> Attempts to stop an ongoing deployment. </summary> <param name="request">Container for the necessary parameters to execute the StopDeployment service method.</param> <returns>The response from the StopDeployment service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentAlreadyCompletedException"> The deployment is already completed. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.StopDeploymentAsync(Amazon.CodeDeploy.Model.StopDeploymentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StopDeployment operation. </summary> <param name="request">Container for the necessary parameters to execute the StopDeployment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.UpdateApplication(Amazon.CodeDeploy.Model.UpdateApplicationRequest)"> <summary> Changes an existing application's name. </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplication service method.</param> <returns>The response from the UpdateApplication service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationAlreadyExistsException"> An application with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.UpdateApplicationAsync(Amazon.CodeDeploy.Model.UpdateApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.UpdateDeploymentGroup(Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest)"> <summary> Changes information about an existing deployment group. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDeploymentGroup service method.</param> <returns>The response from the UpdateDeploymentGroup service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> The deployment configuration does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupAlreadyExistsException"> A deployment group with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> The named deployment group does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidAutoScalingGroupException"> The Auto Scaling group was specified in an invalid format or does not exist. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidEC2TagException"> The tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRoleException"> The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagException"> The specified tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTriggerConfigException"> The trigger was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.LifecycleHookLimitExceededException"> The limit for lifecycle hooks was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TriggerTargetsLimitExceededException"> The maximum allowed number of triggers was exceeded. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.UpdateDeploymentGroupAsync(Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDeploymentGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDeploymentGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.CodeCommit.AmazonCodeCommitClient"> <summary> Implementation for accessing CodeCommit AWS CodeCommit <para> This is the <i>AWS CodeCommit API Reference</i>. This reference provides descriptions of the AWS CodeCommit API. </para> <para> You can use the AWS CodeCommit API to work with the following objects: </para> <ul> <li>Repositories</li> <li>Branches</li> <li>Commits</li> </ul> <para> For information about how to use AWS CodeCommit, see the <i>AWS CodeCommit User Guide</i>. </para> </summary> </member> <member name="T:Amazon.CodeCommit.IAmazonCodeCommit"> <summary> Interface for accessing CodeCommit AWS CodeCommit <para> This is the <i>AWS CodeCommit API Reference</i>. This reference provides descriptions of the AWS CodeCommit API. </para> <para> You can use the AWS CodeCommit API to work with the following objects: </para> <ul> <li>Repositories</li> <li>Branches</li> <li>Commits</li> </ul> <para> For information about how to use AWS CodeCommit, see the <i>AWS CodeCommit User Guide</i>. </para> </summary> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.BatchGetRepositories(Amazon.CodeCommit.Model.BatchGetRepositoriesRequest)"> <summary> Gets information about one or more repositories. <note> <para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the BatchGetRepositories service method.</param> <returns>The response from the BatchGetRepositories service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.MaximumRepositoryNamesExceededException"> The maximum number of allowed repository names was exceeded. Currently, this number is 25. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNamesRequiredException"> A repository names object is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.BatchGetRepositoriesAsync(Amazon.CodeCommit.Model.BatchGetRepositoriesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchGetRepositories operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetRepositories operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.CreateBranch(Amazon.CodeCommit.Model.CreateBranchRequest)"> <summary> Creates a new branch in a repository and points the branch to a commit. <note>Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.</note> </summary> <param name="request">Container for the necessary parameters to execute the CreateBranch service method.</param> <returns>The response from the CreateBranch service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.BranchNameExistsException"> The specified branch name already exists. </exception> <exception cref="T:Amazon.CodeCommit.Model.BranchNameRequiredException"> A branch name is required but was not specified. </exception> <exception cref="T:Amazon.CodeCommit.Model.CommitDoesNotExistException"> The specified commit does not exist or no commit was specified, and the specified repository has no default branch. </exception> <exception cref="T:Amazon.CodeCommit.Model.CommitIdRequiredException"> A commit ID was not specified. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidBranchNameException"> The specified branch name is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidCommitIdException"> The specified commit ID is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.CreateBranchAsync(Amazon.CodeCommit.Model.CreateBranchRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateBranch operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateBranch operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.CreateRepository(Amazon.CodeCommit.Model.CreateRepositoryRequest)"> <summary> Creates a new, empty repository. </summary> <param name="request">Container for the necessary parameters to execute the CreateRepository service method.</param> <returns>The response from the CreateRepository service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryDescriptionException"> The specified repository description is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryLimitExceededException"> A repository resource limit was exceeded. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameExistsException"> The specified repository name already exists. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.CreateRepositoryAsync(Amazon.CodeCommit.Model.CreateRepositoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateRepository operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateRepository operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.DeleteRepository(Amazon.CodeCommit.Model.DeleteRepositoryRequest)"> <summary> Deletes a repository. If a specified repository was already deleted, a null repository ID will be returned. <important>Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository will fail.</important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteRepository service method.</param> <returns>The response from the DeleteRepository service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.DeleteRepositoryAsync(Amazon.CodeCommit.Model.DeleteRepositoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRepository operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRepository operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.GetBranch(Amazon.CodeCommit.Model.GetBranchRequest)"> <summary> Retrieves information about a repository branch, including its name and the last commit ID. </summary> <param name="request">Container for the necessary parameters to execute the GetBranch service method.</param> <returns>The response from the GetBranch service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.BranchDoesNotExistException"> The specified branch does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.BranchNameRequiredException"> A branch name is required but was not specified. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidBranchNameException"> The specified branch name is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.GetBranchAsync(Amazon.CodeCommit.Model.GetBranchRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBranch operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBranch operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.GetRepository(Amazon.CodeCommit.Model.GetRepositoryRequest)"> <summary> Gets information about a repository. <note> <para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the GetRepository service method.</param> <returns>The response from the GetRepository service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.GetRepositoryAsync(Amazon.CodeCommit.Model.GetRepositoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetRepository operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRepository operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.ListBranches(Amazon.CodeCommit.Model.ListBranchesRequest)"> <summary> Gets information about one or more branches in a repository. </summary> <param name="request">Container for the necessary parameters to execute the ListBranches service method.</param> <returns>The response from the ListBranches service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidContinuationTokenException"> The specified continuation token is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.ListBranchesAsync(Amazon.CodeCommit.Model.ListBranchesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListBranches operation. </summary> <param name="request">Container for the necessary parameters to execute the ListBranches operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.ListRepositories(Amazon.CodeCommit.Model.ListRepositoriesRequest)"> <summary> Gets information about one or more repositories. </summary> <param name="request">Container for the necessary parameters to execute the ListRepositories service method.</param> <returns>The response from the ListRepositories service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.InvalidContinuationTokenException"> The specified continuation token is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidOrderException"> The specified sort order is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidSortByException"> The specified sort by value is not valid. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.ListRepositoriesAsync(Amazon.CodeCommit.Model.ListRepositoriesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListRepositories operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRepositories operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.UpdateDefaultBranch(Amazon.CodeCommit.Model.UpdateDefaultBranchRequest)"> <summary> Sets or changes the default branch name for the specified repository. <note>If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.</note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateDefaultBranch service method.</param> <returns>The response from the UpdateDefaultBranch service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.BranchDoesNotExistException"> The specified branch does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.BranchNameRequiredException"> A branch name is required but was not specified. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidBranchNameException"> The specified branch name is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.UpdateDefaultBranchAsync(Amazon.CodeCommit.Model.UpdateDefaultBranchRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDefaultBranch operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDefaultBranch operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.UpdateRepositoryDescription(Amazon.CodeCommit.Model.UpdateRepositoryDescriptionRequest)"> <summary> Sets or changes the comment or description for a repository. <note> <para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateRepositoryDescription service method.</param> <returns>The response from the UpdateRepositoryDescription service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryDescriptionException"> The specified repository description is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.UpdateRepositoryDescriptionAsync(Amazon.CodeCommit.Model.UpdateRepositoryDescriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateRepositoryDescription operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRepositoryDescription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.UpdateRepositoryName(Amazon.CodeCommit.Model.UpdateRepositoryNameRequest)"> <summary> Renames a repository. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRepositoryName service method.</param> <returns>The response from the UpdateRepositoryName service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameExistsException"> The specified repository name already exists. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.UpdateRepositoryNameAsync(Amazon.CodeCommit.Model.UpdateRepositoryNameRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateRepositoryName operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRepositoryName operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor"> <summary> Constructs AmazonCodeCommitClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodeCommitClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(Amazon.CodeCommit.AmazonCodeCommitConfig)"> <summary> Constructs AmazonCodeCommitClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCodeCommitClient Configuration Object</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCodeCommitClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodeCommitClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CodeCommit.AmazonCodeCommitConfig)"> <summary> Constructs AmazonCodeCommitClient with AWS Credentials and an AmazonCodeCommitClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCodeCommitClient Configuration Object</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCodeCommitClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodeCommitClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(System.String,System.String,Amazon.CodeCommit.AmazonCodeCommitConfig)"> <summary> Constructs AmazonCodeCommitClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeCommitClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCodeCommitClient Configuration Object</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCodeCommitClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodeCommitClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(System.String,System.String,System.String,Amazon.CodeCommit.AmazonCodeCommitConfig)"> <summary> Constructs AmazonCodeCommitClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeCommitClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCodeCommitClient Configuration Object</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.BatchGetRepositories(Amazon.CodeCommit.Model.BatchGetRepositoriesRequest)"> <summary> Gets information about one or more repositories. <note> <para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the BatchGetRepositories service method.</param> <returns>The response from the BatchGetRepositories service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.MaximumRepositoryNamesExceededException"> The maximum number of allowed repository names was exceeded. Currently, this number is 25. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNamesRequiredException"> A repository names object is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.BatchGetRepositoriesAsync(Amazon.CodeCommit.Model.BatchGetRepositoriesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchGetRepositories operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetRepositories operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.CreateBranch(Amazon.CodeCommit.Model.CreateBranchRequest)"> <summary> Creates a new branch in a repository and points the branch to a commit. <note>Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.</note> </summary> <param name="request">Container for the necessary parameters to execute the CreateBranch service method.</param> <returns>The response from the CreateBranch service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.BranchNameExistsException"> The specified branch name already exists. </exception> <exception cref="T:Amazon.CodeCommit.Model.BranchNameRequiredException"> A branch name is required but was not specified. </exception> <exception cref="T:Amazon.CodeCommit.Model.CommitDoesNotExistException"> The specified commit does not exist or no commit was specified, and the specified repository has no default branch. </exception> <exception cref="T:Amazon.CodeCommit.Model.CommitIdRequiredException"> A commit ID was not specified. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidBranchNameException"> The specified branch name is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidCommitIdException"> The specified commit ID is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.CreateBranchAsync(Amazon.CodeCommit.Model.CreateBranchRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateBranch operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateBranch operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.CreateRepository(Amazon.CodeCommit.Model.CreateRepositoryRequest)"> <summary> Creates a new, empty repository. </summary> <param name="request">Container for the necessary parameters to execute the CreateRepository service method.</param> <returns>The response from the CreateRepository service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryDescriptionException"> The specified repository description is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryLimitExceededException"> A repository resource limit was exceeded. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameExistsException"> The specified repository name already exists. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.CreateRepositoryAsync(Amazon.CodeCommit.Model.CreateRepositoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateRepository operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateRepository operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.DeleteRepository(Amazon.CodeCommit.Model.DeleteRepositoryRequest)"> <summary> Deletes a repository. If a specified repository was already deleted, a null repository ID will be returned. <important>Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository will fail.</important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteRepository service method.</param> <returns>The response from the DeleteRepository service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.DeleteRepositoryAsync(Amazon.CodeCommit.Model.DeleteRepositoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRepository operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRepository operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.GetBranch(Amazon.CodeCommit.Model.GetBranchRequest)"> <summary> Retrieves information about a repository branch, including its name and the last commit ID. </summary> <param name="request">Container for the necessary parameters to execute the GetBranch service method.</param> <returns>The response from the GetBranch service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.BranchDoesNotExistException"> The specified branch does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.BranchNameRequiredException"> A branch name is required but was not specified. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidBranchNameException"> The specified branch name is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.GetBranchAsync(Amazon.CodeCommit.Model.GetBranchRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBranch operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBranch operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.GetRepository(Amazon.CodeCommit.Model.GetRepositoryRequest)"> <summary> Gets information about a repository. <note> <para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the GetRepository service method.</param> <returns>The response from the GetRepository service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.GetRepositoryAsync(Amazon.CodeCommit.Model.GetRepositoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetRepository operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRepository operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.ListBranches(Amazon.CodeCommit.Model.ListBranchesRequest)"> <summary> Gets information about one or more branches in a repository. </summary> <param name="request">Container for the necessary parameters to execute the ListBranches service method.</param> <returns>The response from the ListBranches service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidContinuationTokenException"> The specified continuation token is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.ListBranchesAsync(Amazon.CodeCommit.Model.ListBranchesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListBranches operation. </summary> <param name="request">Container for the necessary parameters to execute the ListBranches operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.ListRepositories(Amazon.CodeCommit.Model.ListRepositoriesRequest)"> <summary> Gets information about one or more repositories. </summary> <param name="request">Container for the necessary parameters to execute the ListRepositories service method.</param> <returns>The response from the ListRepositories service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.InvalidContinuationTokenException"> The specified continuation token is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidOrderException"> The specified sort order is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidSortByException"> The specified sort by value is not valid. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.ListRepositoriesAsync(Amazon.CodeCommit.Model.ListRepositoriesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListRepositories operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRepositories operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.UpdateDefaultBranch(Amazon.CodeCommit.Model.UpdateDefaultBranchRequest)"> <summary> Sets or changes the default branch name for the specified repository. <note>If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.</note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateDefaultBranch service method.</param> <returns>The response from the UpdateDefaultBranch service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.BranchDoesNotExistException"> The specified branch does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.BranchNameRequiredException"> A branch name is required but was not specified. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidBranchNameException"> The specified branch name is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.UpdateDefaultBranchAsync(Amazon.CodeCommit.Model.UpdateDefaultBranchRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDefaultBranch operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDefaultBranch operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.UpdateRepositoryDescription(Amazon.CodeCommit.Model.UpdateRepositoryDescriptionRequest)"> <summary> Sets or changes the comment or description for a repository. <note> <para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateRepositoryDescription service method.</param> <returns>The response from the UpdateRepositoryDescription service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryDescriptionException"> The specified repository description is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.UpdateRepositoryDescriptionAsync(Amazon.CodeCommit.Model.UpdateRepositoryDescriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateRepositoryDescription operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRepositoryDescription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.UpdateRepositoryName(Amazon.CodeCommit.Model.UpdateRepositoryNameRequest)"> <summary> Renames a repository. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRepositoryName service method.</param> <returns>The response from the UpdateRepositoryName service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameExistsException"> The specified repository name already exists. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.UpdateRepositoryNameAsync(Amazon.CodeCommit.Model.UpdateRepositoryNameRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateRepositoryName operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRepositoryName operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.CodePipeline.AmazonCodePipelineClient"> <summary> Implementation for accessing CodePipeline AWS CodePipeline <b>Overview</b> <para> This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information, see the <a href="http://docs.aws.amazon.com/pipelines/latest/userguide/welcome.html">AWS CodePipeline User Guide</a>. </para> <para> You can use the AWS CodePipeline API to work with pipelines, stages, actions, gates, and transitions, as described below. </para> <para> <i>Pipelines</i> are models of automated release processes. Each pipeline is uniquely named, and consists of actions, gates, and stages. </para> <para> You can work with pipelines by calling: <ul> <li> <a>CreatePipeline</a>, which creates a uniquely-named pipeline.</li> <li> <a>DeletePipeline</a>, which deletes the specified pipeline.</li> <li> <a>GetPipeline</a>, which returns information about a pipeline structure.</li> <li> <a>GetPipelineState</a>, which returns information about the current state of the stages and actions of a pipeline.</li> <li> <a>ListPipelines</a>, which gets a summary of all of the pipelines associated with your account.</li> <li> <a>StartPipelineExecution</a>, which runs the the most recent revision of an artifact through the pipeline.</li> <li> <a>UpdatePipeline</a>, which updates a pipeline with edits or changes to the structure of the pipeline.</li> </ul> <para> Pipelines include <i>stages</i>, which are which are logical groupings of gates and actions. Each stage contains one or more actions that must complete before the next stage begins. A stage will result in success or failure. If a stage fails, then the pipeline stops at that stage and will remain stopped until either a new version of an artifact appears in the source location, or a user takes action to re-run the most recent artifact through the pipeline. You can call <a>GetPipelineState</a>, which displays the status of a pipeline, including the status of stages in the pipeline, or <a>GetPipeline</a>, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, also refer to the <ulink url="http://docs.aws.amazon.com/codepipeline/latest/UserGuide/pipeline-structure.html">AWS CodePipeline Pipeline Structure Reference</ulink>. </para> </para> <para> Pipeline stages include <i>actions</i>, which are categorized into categories such as source or build actions performed within a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as <a>CreatePipeline</a> and <a>GetPipelineState</a>. </para> <para> Pipelines also include <i>transitions</i>, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete. </para> <para> You can work with transitions by calling: </para> <ul> <li> <a>DisableStageTransition</a>, which prevents artifacts from transitioning to the next stage in a pipeline.</li> <li> <a>EnableStageTransition</a>, which enables transition of artifacts between stages in a pipeline. </li> </ul> <para> <b>Using the API to integrate with AWS CodePipeline</b> </para> <para> For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. In order to integrate with AWS CodePipeline, developers will need to work with the following items: </para> <ul> <li>Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source. <para> You can work with jobs by calling: </para> <ul> <li> <a>AcknowledgeJob</a>, which confirms whether a job worker has received the specified job,</li> <li> <a>GetJobDetails</a>, which returns the details of a job,</li> <li> <a>PollForJobs</a>, which determines whether there are any jobs to act upon, </li> <li> <a>PutJobFailureResult</a>, which provides details of a job failure, and</li> <li> <a>PutJobSuccessResult</a>, which provides details of a job success.</li> </ul> </li> <li>Third party jobs, which are instances of an action created by a partner action and integrated into AWS CodePipeline. Partner actions are created by members of the AWS Partner Network. <para> You can work with third party jobs by calling: </para> <ul> <li> <a>AcknowledgeThirdPartyJob</a>, which confirms whether a job worker has received the specified job,</li> <li> <a>GetThirdPartyJobDetails</a>, which requests the details of a job for a partner action,</li> <li> <a>PollForThirdPartyJobs</a>, which determines whether there are any jobs to act upon, </li> <li> <a>PutThirdPartyJobFailureResult</a>, which provides details of a job failure, and</li> <li> <a>PutThirdPartyJobSuccessResult</a>, which provides details of a job success.</li> </ul> </li> </ul> </summary> </member> <member name="T:Amazon.CodePipeline.IAmazonCodePipeline"> <summary> Interface for accessing CodePipeline AWS CodePipeline <b>Overview</b> <para> This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information, see the <a href="http://docs.aws.amazon.com/pipelines/latest/userguide/welcome.html">AWS CodePipeline User Guide</a>. </para> <para> You can use the AWS CodePipeline API to work with pipelines, stages, actions, gates, and transitions, as described below. </para> <para> <i>Pipelines</i> are models of automated release processes. Each pipeline is uniquely named, and consists of actions, gates, and stages. </para> <para> You can work with pipelines by calling: <ul> <li> <a>CreatePipeline</a>, which creates a uniquely-named pipeline.</li> <li> <a>DeletePipeline</a>, which deletes the specified pipeline.</li> <li> <a>GetPipeline</a>, which returns information about a pipeline structure.</li> <li> <a>GetPipelineState</a>, which returns information about the current state of the stages and actions of a pipeline.</li> <li> <a>ListPipelines</a>, which gets a summary of all of the pipelines associated with your account.</li> <li> <a>StartPipelineExecution</a>, which runs the the most recent revision of an artifact through the pipeline.</li> <li> <a>UpdatePipeline</a>, which updates a pipeline with edits or changes to the structure of the pipeline.</li> </ul> <para> Pipelines include <i>stages</i>, which are which are logical groupings of gates and actions. Each stage contains one or more actions that must complete before the next stage begins. A stage will result in success or failure. If a stage fails, then the pipeline stops at that stage and will remain stopped until either a new version of an artifact appears in the source location, or a user takes action to re-run the most recent artifact through the pipeline. You can call <a>GetPipelineState</a>, which displays the status of a pipeline, including the status of stages in the pipeline, or <a>GetPipeline</a>, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, also refer to the <ulink url="http://docs.aws.amazon.com/codepipeline/latest/UserGuide/pipeline-structure.html">AWS CodePipeline Pipeline Structure Reference</ulink>. </para> </para> <para> Pipeline stages include <i>actions</i>, which are categorized into categories such as source or build actions performed within a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as <a>CreatePipeline</a> and <a>GetPipelineState</a>. </para> <para> Pipelines also include <i>transitions</i>, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete. </para> <para> You can work with transitions by calling: </para> <ul> <li> <a>DisableStageTransition</a>, which prevents artifacts from transitioning to the next stage in a pipeline.</li> <li> <a>EnableStageTransition</a>, which enables transition of artifacts between stages in a pipeline. </li> </ul> <para> <b>Using the API to integrate with AWS CodePipeline</b> </para> <para> For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. In order to integrate with AWS CodePipeline, developers will need to work with the following items: </para> <ul> <li>Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source. <para> You can work with jobs by calling: </para> <ul> <li> <a>AcknowledgeJob</a>, which confirms whether a job worker has received the specified job,</li> <li> <a>GetJobDetails</a>, which returns the details of a job,</li> <li> <a>PollForJobs</a>, which determines whether there are any jobs to act upon, </li> <li> <a>PutJobFailureResult</a>, which provides details of a job failure, and</li> <li> <a>PutJobSuccessResult</a>, which provides details of a job success.</li> </ul> </li> <li>Third party jobs, which are instances of an action created by a partner action and integrated into AWS CodePipeline. Partner actions are created by members of the AWS Partner Network. <para> You can work with third party jobs by calling: </para> <ul> <li> <a>AcknowledgeThirdPartyJob</a>, which confirms whether a job worker has received the specified job,</li> <li> <a>GetThirdPartyJobDetails</a>, which requests the details of a job for a partner action,</li> <li> <a>PollForThirdPartyJobs</a>, which determines whether there are any jobs to act upon, </li> <li> <a>PutThirdPartyJobFailureResult</a>, which provides details of a job failure, and</li> <li> <a>PutThirdPartyJobSuccessResult</a>, which provides details of a job success.</li> </ul> </li> </ul> </summary> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.AcknowledgeJob(System.String,System.String)"> <summary> Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions. </summary> <param name="jobId">The unique system-generated ID of the job for which you want to confirm receipt.</param> <param name="nonce">A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.</param> <returns>The response from the AcknowledgeJob service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNonceException"> The specified nonce was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.AcknowledgeJob(Amazon.CodePipeline.Model.AcknowledgeJobRequest)"> <summary> Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions. </summary> <param name="request">Container for the necessary parameters to execute the AcknowledgeJob service method.</param> <returns>The response from the AcknowledgeJob service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNonceException"> The specified nonce was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.AcknowledgeJobAsync(Amazon.CodePipeline.Model.AcknowledgeJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AcknowledgeJob operation. </summary> <param name="request">Container for the necessary parameters to execute the AcknowledgeJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.AcknowledgeThirdPartyJob(System.String,System.String,System.String)"> <summary> Confirms a job worker has received the specified job. Only used for partner actions. </summary> <param name="clientToken">The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</param> <param name="jobId">The unique system-generated ID of the job.</param> <param name="nonce">A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.</param> <returns>The response from the AcknowledgeThirdPartyJob service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidNonceException"> The specified nonce was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.AcknowledgeThirdPartyJob(Amazon.CodePipeline.Model.AcknowledgeThirdPartyJobRequest)"> <summary> Confirms a job worker has received the specified job. Only used for partner actions. </summary> <param name="request">Container for the necessary parameters to execute the AcknowledgeThirdPartyJob service method.</param> <returns>The response from the AcknowledgeThirdPartyJob service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidNonceException"> The specified nonce was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.AcknowledgeThirdPartyJobAsync(Amazon.CodePipeline.Model.AcknowledgeThirdPartyJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AcknowledgeThirdPartyJob operation. </summary> <param name="request">Container for the necessary parameters to execute the AcknowledgeThirdPartyJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.CreateCustomActionType(Amazon.CodePipeline.Model.CreateCustomActionTypeRequest)"> <summary> Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions. </summary> <param name="request">Container for the necessary parameters to execute the CreateCustomActionType service method.</param> <returns>The response from the CreateCustomActionType service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.LimitExceededException"> The number of pipelines associated with the AWS account has exceeded the limit allowed for the account. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.CreateCustomActionTypeAsync(Amazon.CodePipeline.Model.CreateCustomActionTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCustomActionType operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCustomActionType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.CreatePipeline(Amazon.CodePipeline.Model.PipelineDeclaration)"> <summary> Creates a pipeline. </summary> <param name="pipeline">A property of CreatePipelineRequest used to execute the CreatePipeline service method.</param> <returns>The response from the CreatePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> The specified action declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> The specified gate declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> The specified stage declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStructureException"> The specified structure was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.LimitExceededException"> The number of pipelines associated with the AWS account has exceeded the limit allowed for the account. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineNameInUseException"> The specified pipeline name is already in use. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.CreatePipeline(Amazon.CodePipeline.Model.CreatePipelineRequest)"> <summary> Creates a pipeline. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline service method.</param> <returns>The response from the CreatePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> The specified action declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> The specified gate declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> The specified stage declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStructureException"> The specified structure was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.LimitExceededException"> The number of pipelines associated with the AWS account has exceeded the limit allowed for the account. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineNameInUseException"> The specified pipeline name is already in use. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.CreatePipelineAsync(Amazon.CodePipeline.Model.CreatePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.DeleteCustomActionType(Amazon.CodePipeline.Model.DeleteCustomActionTypeRequest)"> <summary> Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions. <important> <para> You cannot recreate a custom action after it has been deleted unless you increase the version number of the action. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteCustomActionType service method.</param> <returns>The response from the DeleteCustomActionType service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.DeleteCustomActionTypeAsync(Amazon.CodePipeline.Model.DeleteCustomActionTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCustomActionType operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCustomActionType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.DeletePipeline(System.String)"> <summary> Deletes the specified pipeline. </summary> <param name="name">The name of the pipeline to be deleted.</param> <returns>The response from the DeletePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.DeletePipeline(Amazon.CodePipeline.Model.DeletePipelineRequest)"> <summary> Deletes the specified pipeline. </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline service method.</param> <returns>The response from the DeletePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.DeletePipelineAsync(Amazon.CodePipeline.Model.DeletePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.DisableStageTransition(Amazon.CodePipeline.Model.DisableStageTransitionRequest)"> <summary> Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline. </summary> <param name="request">Container for the necessary parameters to execute the DisableStageTransition service method.</param> <returns>The response from the DisableStageTransition service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.StageNotFoundException"> The specified stage was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.DisableStageTransitionAsync(Amazon.CodePipeline.Model.DisableStageTransitionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableStageTransition operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableStageTransition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EnableStageTransition(Amazon.CodePipeline.Model.EnableStageTransitionRequest)"> <summary> Enables artifacts in a pipeline to transition to a stage in a pipeline. </summary> <param name="request">Container for the necessary parameters to execute the EnableStageTransition service method.</param> <returns>The response from the EnableStageTransition service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.StageNotFoundException"> The specified stage was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EnableStageTransitionAsync(Amazon.CodePipeline.Model.EnableStageTransitionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableStageTransition operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableStageTransition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetJobDetails(System.String)"> <summary> Returns information about a job. Only used for custom actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="jobId">The unique system-generated ID for the job.</param> <returns>The response from the GetJobDetails service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetJobDetails(Amazon.CodePipeline.Model.GetJobDetailsRequest)"> <summary> Returns information about a job. Only used for custom actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the GetJobDetails service method.</param> <returns>The response from the GetJobDetails service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetJobDetailsAsync(Amazon.CodePipeline.Model.GetJobDetailsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetJobDetails operation. </summary> <param name="request">Container for the necessary parameters to execute the GetJobDetails operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetPipeline(System.String,System.Int32)"> <summary> Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with <a>UpdatePipeline</a>. </summary> <param name="name">The name of the pipeline for which you want to get information. Pipeline names must be unique under an Amazon Web Services (AWS) user account.</param> <param name="version">The version number of the pipeline. If you do not specify a version, defaults to the most current version.</param> <returns>The response from the GetPipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineVersionNotFoundException"> The specified pipeline version was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetPipeline(System.String)"> <summary> Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with <a>UpdatePipeline</a>. </summary> <param name="name">The name of the pipeline for which you want to get information. Pipeline names must be unique under an Amazon Web Services (AWS) user account.</param> <returns>The response from the GetPipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineVersionNotFoundException"> The specified pipeline version was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetPipeline(Amazon.CodePipeline.Model.GetPipelineRequest)"> <summary> Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with <a>UpdatePipeline</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetPipeline service method.</param> <returns>The response from the GetPipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineVersionNotFoundException"> The specified pipeline version was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetPipelineAsync(Amazon.CodePipeline.Model.GetPipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetPipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetPipelineState(System.String)"> <summary> Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline. </summary> <param name="name">The name of the pipeline about which you want to get information.</param> <returns>The response from the GetPipelineState service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetPipelineState(Amazon.CodePipeline.Model.GetPipelineStateRequest)"> <summary> Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline. </summary> <param name="request">Container for the necessary parameters to execute the GetPipelineState service method.</param> <returns>The response from the GetPipelineState service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetPipelineStateAsync(Amazon.CodePipeline.Model.GetPipelineStateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetPipelineState operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPipelineState operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetThirdPartyJobDetails(System.String,System.String)"> <summary> Requests the details of a job for a third party action. Only used for partner actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="clientToken">The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</param> <param name="jobId">The unique system-generated ID used for identifying the job.</param> <returns>The response from the GetThirdPartyJobDetails service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetThirdPartyJobDetails(Amazon.CodePipeline.Model.GetThirdPartyJobDetailsRequest)"> <summary> Requests the details of a job for a third party action. Only used for partner actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the GetThirdPartyJobDetails service method.</param> <returns>The response from the GetThirdPartyJobDetails service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetThirdPartyJobDetailsAsync(Amazon.CodePipeline.Model.GetThirdPartyJobDetailsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetThirdPartyJobDetails operation. </summary> <param name="request">Container for the necessary parameters to execute the GetThirdPartyJobDetails operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.ListActionTypes"> <summary> Gets a summary of all AWS CodePipeline action types associated with your account. </summary> <returns>The response from the ListActionTypes service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.ListActionTypes(Amazon.CodePipeline.ActionOwner)"> <summary> Gets a summary of all AWS CodePipeline action types associated with your account. </summary> <param name="actionOwnerFilter">Filters the list of action types to those created by a specified entity.</param> <returns>The response from the ListActionTypes service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.ListActionTypes(Amazon.CodePipeline.Model.ListActionTypesRequest)"> <summary> Gets a summary of all AWS CodePipeline action types associated with your account. </summary> <param name="request">Container for the necessary parameters to execute the ListActionTypes service method.</param> <returns>The response from the ListActionTypes service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.ListActionTypesAsync(Amazon.CodePipeline.Model.ListActionTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListActionTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the ListActionTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.ListPipelines"> <summary> Gets a summary of all of the pipelines associated with your account. </summary> <returns>The response from the ListPipelines service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.ListPipelines(Amazon.CodePipeline.Model.ListPipelinesRequest)"> <summary> Gets a summary of all of the pipelines associated with your account. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines service method.</param> <returns>The response from the ListPipelines service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.ListPipelinesAsync(Amazon.CodePipeline.Model.ListPipelinesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListPipelines operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PollForJobs(Amazon.CodePipeline.Model.PollForJobsRequest)"> <summary> Returns information about any jobs for AWS CodePipeline to act upon. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the PollForJobs service method.</param> <returns>The response from the PollForJobs service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ActionTypeNotFoundException"> The specified action type cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PollForJobsAsync(Amazon.CodePipeline.Model.PollForJobsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PollForJobs operation. </summary> <param name="request">Container for the necessary parameters to execute the PollForJobs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PollForThirdPartyJobs(Amazon.CodePipeline.Model.PollForThirdPartyJobsRequest)"> <summary> Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the PollForThirdPartyJobs service method.</param> <returns>The response from the PollForThirdPartyJobs service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ActionTypeNotFoundException"> The specified action type cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PollForThirdPartyJobsAsync(Amazon.CodePipeline.Model.PollForThirdPartyJobsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PollForThirdPartyJobs operation. </summary> <param name="request">Container for the necessary parameters to execute the PollForThirdPartyJobs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutActionRevision(Amazon.CodePipeline.Model.PutActionRevisionRequest)"> <summary> Provides information to AWS CodePipeline about new revisions to a source. </summary> <param name="request">Container for the necessary parameters to execute the PutActionRevision service method.</param> <returns>The response from the PutActionRevision service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ActionNotFoundException"> The specified action cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.StageNotFoundException"> The specified stage was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutActionRevisionAsync(Amazon.CodePipeline.Model.PutActionRevisionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutActionRevision operation. </summary> <param name="request">Container for the necessary parameters to execute the PutActionRevision operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutJobFailureResult(System.String,Amazon.CodePipeline.Model.FailureDetails)"> <summary> Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions. </summary> <param name="jobId">The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.</param> <param name="failureDetails">The details about the failure of a job. </param> <returns>The response from the PutJobFailureResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutJobFailureResult(Amazon.CodePipeline.Model.PutJobFailureResultRequest)"> <summary> Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions. </summary> <param name="request">Container for the necessary parameters to execute the PutJobFailureResult service method.</param> <returns>The response from the PutJobFailureResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutJobFailureResultAsync(Amazon.CodePipeline.Model.PutJobFailureResultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutJobFailureResult operation. </summary> <param name="request">Container for the necessary parameters to execute the PutJobFailureResult operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutJobSuccessResult(Amazon.CodePipeline.Model.PutJobSuccessResultRequest)"> <summary> Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions. </summary> <param name="request">Container for the necessary parameters to execute the PutJobSuccessResult service method.</param> <returns>The response from the PutJobSuccessResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutJobSuccessResultAsync(Amazon.CodePipeline.Model.PutJobSuccessResultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutJobSuccessResult operation. </summary> <param name="request">Container for the necessary parameters to execute the PutJobSuccessResult operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutThirdPartyJobFailureResult(System.String,System.String,Amazon.CodePipeline.Model.FailureDetails)"> <summary> Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions. </summary> <param name="jobId">The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.</param> <param name="clientToken">The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</param> <param name="failureDetails">A property of PutThirdPartyJobFailureResultRequest used to execute the PutThirdPartyJobFailureResult service method.</param> <returns>The response from the PutThirdPartyJobFailureResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutThirdPartyJobFailureResult(Amazon.CodePipeline.Model.PutThirdPartyJobFailureResultRequest)"> <summary> Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions. </summary> <param name="request">Container for the necessary parameters to execute the PutThirdPartyJobFailureResult service method.</param> <returns>The response from the PutThirdPartyJobFailureResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutThirdPartyJobFailureResultAsync(Amazon.CodePipeline.Model.PutThirdPartyJobFailureResultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutThirdPartyJobFailureResult operation. </summary> <param name="request">Container for the necessary parameters to execute the PutThirdPartyJobFailureResult operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutThirdPartyJobSuccessResult(Amazon.CodePipeline.Model.PutThirdPartyJobSuccessResultRequest)"> <summary> Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions. </summary> <param name="request">Container for the necessary parameters to execute the PutThirdPartyJobSuccessResult service method.</param> <returns>The response from the PutThirdPartyJobSuccessResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutThirdPartyJobSuccessResultAsync(Amazon.CodePipeline.Model.PutThirdPartyJobSuccessResultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutThirdPartyJobSuccessResult operation. </summary> <param name="request">Container for the necessary parameters to execute the PutThirdPartyJobSuccessResult operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.StartPipelineExecution(System.String)"> <summary> Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. </summary> <param name="name">The name of the pipeline to start.</param> <returns>The response from the StartPipelineExecution service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.StartPipelineExecution(Amazon.CodePipeline.Model.StartPipelineExecutionRequest)"> <summary> Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. </summary> <param name="request">Container for the necessary parameters to execute the StartPipelineExecution service method.</param> <returns>The response from the StartPipelineExecution service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.StartPipelineExecutionAsync(Amazon.CodePipeline.Model.StartPipelineExecutionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartPipelineExecution operation. </summary> <param name="request">Container for the necessary parameters to execute the StartPipelineExecution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.UpdatePipeline(Amazon.CodePipeline.Model.PipelineDeclaration)"> <summary> Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1. </summary> <param name="pipeline">The name of the pipeline to be updated.</param> <returns>The response from the UpdatePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> The specified action declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> The specified gate declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> The specified stage declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStructureException"> The specified structure was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.UpdatePipeline(Amazon.CodePipeline.Model.UpdatePipelineRequest)"> <summary> Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1. </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipeline service method.</param> <returns>The response from the UpdatePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> The specified action declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> The specified gate declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> The specified stage declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStructureException"> The specified structure was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.UpdatePipelineAsync(Amazon.CodePipeline.Model.UpdatePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor"> <summary> Constructs AmazonCodePipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodePipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(Amazon.CodePipeline.AmazonCodePipelineConfig)"> <summary> Constructs AmazonCodePipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCodePipelineClient Configuration Object</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCodePipelineClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodePipelineClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CodePipeline.AmazonCodePipelineConfig)"> <summary> Constructs AmazonCodePipelineClient with AWS Credentials and an AmazonCodePipelineClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCodePipelineClient Configuration Object</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCodePipelineClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodePipelineClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(System.String,System.String,Amazon.CodePipeline.AmazonCodePipelineConfig)"> <summary> Constructs AmazonCodePipelineClient with AWS Access Key ID, AWS Secret Key and an AmazonCodePipelineClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCodePipelineClient Configuration Object</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCodePipelineClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodePipelineClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(System.String,System.String,System.String,Amazon.CodePipeline.AmazonCodePipelineConfig)"> <summary> Constructs AmazonCodePipelineClient with AWS Access Key ID, AWS Secret Key and an AmazonCodePipelineClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCodePipelineClient Configuration Object</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.AcknowledgeJob(System.String,System.String)"> <summary> Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions. </summary> <param name="jobId">The unique system-generated ID of the job for which you want to confirm receipt.</param> <param name="nonce">A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.</param> <returns>The response from the AcknowledgeJob service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNonceException"> The specified nonce was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.AcknowledgeJob(Amazon.CodePipeline.Model.AcknowledgeJobRequest)"> <summary> Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions. </summary> <param name="request">Container for the necessary parameters to execute the AcknowledgeJob service method.</param> <returns>The response from the AcknowledgeJob service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNonceException"> The specified nonce was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.AcknowledgeJobAsync(Amazon.CodePipeline.Model.AcknowledgeJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AcknowledgeJob operation. </summary> <param name="request">Container for the necessary parameters to execute the AcknowledgeJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.AcknowledgeThirdPartyJob(System.String,System.String,System.String)"> <summary> Confirms a job worker has received the specified job. Only used for partner actions. </summary> <param name="clientToken">The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</param> <param name="jobId">The unique system-generated ID of the job.</param> <param name="nonce">A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.</param> <returns>The response from the AcknowledgeThirdPartyJob service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidNonceException"> The specified nonce was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.AcknowledgeThirdPartyJob(Amazon.CodePipeline.Model.AcknowledgeThirdPartyJobRequest)"> <summary> Confirms a job worker has received the specified job. Only used for partner actions. </summary> <param name="request">Container for the necessary parameters to execute the AcknowledgeThirdPartyJob service method.</param> <returns>The response from the AcknowledgeThirdPartyJob service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidNonceException"> The specified nonce was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.AcknowledgeThirdPartyJobAsync(Amazon.CodePipeline.Model.AcknowledgeThirdPartyJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AcknowledgeThirdPartyJob operation. </summary> <param name="request">Container for the necessary parameters to execute the AcknowledgeThirdPartyJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.CreateCustomActionType(Amazon.CodePipeline.Model.CreateCustomActionTypeRequest)"> <summary> Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions. </summary> <param name="request">Container for the necessary parameters to execute the CreateCustomActionType service method.</param> <returns>The response from the CreateCustomActionType service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.LimitExceededException"> The number of pipelines associated with the AWS account has exceeded the limit allowed for the account. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.CreateCustomActionTypeAsync(Amazon.CodePipeline.Model.CreateCustomActionTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCustomActionType operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCustomActionType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.CreatePipeline(Amazon.CodePipeline.Model.PipelineDeclaration)"> <summary> Creates a pipeline. </summary> <param name="pipeline">A property of CreatePipelineRequest used to execute the CreatePipeline service method.</param> <returns>The response from the CreatePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> The specified action declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> The specified gate declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> The specified stage declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStructureException"> The specified structure was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.LimitExceededException"> The number of pipelines associated with the AWS account has exceeded the limit allowed for the account. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineNameInUseException"> The specified pipeline name is already in use. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.CreatePipeline(Amazon.CodePipeline.Model.CreatePipelineRequest)"> <summary> Creates a pipeline. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline service method.</param> <returns>The response from the CreatePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> The specified action declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> The specified gate declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> The specified stage declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStructureException"> The specified structure was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.LimitExceededException"> The number of pipelines associated with the AWS account has exceeded the limit allowed for the account. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineNameInUseException"> The specified pipeline name is already in use. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.CreatePipelineAsync(Amazon.CodePipeline.Model.CreatePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.DeleteCustomActionType(Amazon.CodePipeline.Model.DeleteCustomActionTypeRequest)"> <summary> Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions. <important> <para> You cannot recreate a custom action after it has been deleted unless you increase the version number of the action. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteCustomActionType service method.</param> <returns>The response from the DeleteCustomActionType service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.DeleteCustomActionTypeAsync(Amazon.CodePipeline.Model.DeleteCustomActionTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCustomActionType operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCustomActionType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.DeletePipeline(System.String)"> <summary> Deletes the specified pipeline. </summary> <param name="name">The name of the pipeline to be deleted.</param> <returns>The response from the DeletePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.DeletePipeline(Amazon.CodePipeline.Model.DeletePipelineRequest)"> <summary> Deletes the specified pipeline. </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline service method.</param> <returns>The response from the DeletePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.DeletePipelineAsync(Amazon.CodePipeline.Model.DeletePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.DisableStageTransition(Amazon.CodePipeline.Model.DisableStageTransitionRequest)"> <summary> Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline. </summary> <param name="request">Container for the necessary parameters to execute the DisableStageTransition service method.</param> <returns>The response from the DisableStageTransition service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.StageNotFoundException"> The specified stage was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.DisableStageTransitionAsync(Amazon.CodePipeline.Model.DisableStageTransitionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableStageTransition operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableStageTransition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EnableStageTransition(Amazon.CodePipeline.Model.EnableStageTransitionRequest)"> <summary> Enables artifacts in a pipeline to transition to a stage in a pipeline. </summary> <param name="request">Container for the necessary parameters to execute the EnableStageTransition service method.</param> <returns>The response from the EnableStageTransition service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.StageNotFoundException"> The specified stage was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EnableStageTransitionAsync(Amazon.CodePipeline.Model.EnableStageTransitionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableStageTransition operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableStageTransition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetJobDetails(System.String)"> <summary> Returns information about a job. Only used for custom actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="jobId">The unique system-generated ID for the job.</param> <returns>The response from the GetJobDetails service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetJobDetails(Amazon.CodePipeline.Model.GetJobDetailsRequest)"> <summary> Returns information about a job. Only used for custom actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the GetJobDetails service method.</param> <returns>The response from the GetJobDetails service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetJobDetailsAsync(Amazon.CodePipeline.Model.GetJobDetailsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetJobDetails operation. </summary> <param name="request">Container for the necessary parameters to execute the GetJobDetails operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetPipeline(System.String,System.Int32)"> <summary> Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with <a>UpdatePipeline</a>. </summary> <param name="name">The name of the pipeline for which you want to get information. Pipeline names must be unique under an Amazon Web Services (AWS) user account.</param> <param name="version">The version number of the pipeline. If you do not specify a version, defaults to the most current version.</param> <returns>The response from the GetPipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineVersionNotFoundException"> The specified pipeline version was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetPipeline(System.String)"> <summary> Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with <a>UpdatePipeline</a>. </summary> <param name="name">The name of the pipeline for which you want to get information. Pipeline names must be unique under an Amazon Web Services (AWS) user account.</param> <returns>The response from the GetPipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineVersionNotFoundException"> The specified pipeline version was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetPipeline(Amazon.CodePipeline.Model.GetPipelineRequest)"> <summary> Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with <a>UpdatePipeline</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetPipeline service method.</param> <returns>The response from the GetPipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineVersionNotFoundException"> The specified pipeline version was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetPipelineAsync(Amazon.CodePipeline.Model.GetPipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetPipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetPipelineState(System.String)"> <summary> Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline. </summary> <param name="name">The name of the pipeline about which you want to get information.</param> <returns>The response from the GetPipelineState service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetPipelineState(Amazon.CodePipeline.Model.GetPipelineStateRequest)"> <summary> Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline. </summary> <param name="request">Container for the necessary parameters to execute the GetPipelineState service method.</param> <returns>The response from the GetPipelineState service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetPipelineStateAsync(Amazon.CodePipeline.Model.GetPipelineStateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetPipelineState operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPipelineState operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetThirdPartyJobDetails(System.String,System.String)"> <summary> Requests the details of a job for a third party action. Only used for partner actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="clientToken">The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</param> <param name="jobId">The unique system-generated ID used for identifying the job.</param> <returns>The response from the GetThirdPartyJobDetails service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetThirdPartyJobDetails(Amazon.CodePipeline.Model.GetThirdPartyJobDetailsRequest)"> <summary> Requests the details of a job for a third party action. Only used for partner actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the GetThirdPartyJobDetails service method.</param> <returns>The response from the GetThirdPartyJobDetails service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetThirdPartyJobDetailsAsync(Amazon.CodePipeline.Model.GetThirdPartyJobDetailsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetThirdPartyJobDetails operation. </summary> <param name="request">Container for the necessary parameters to execute the GetThirdPartyJobDetails operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.ListActionTypes"> <summary> Gets a summary of all AWS CodePipeline action types associated with your account. </summary> <returns>The response from the ListActionTypes service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.ListActionTypes(Amazon.CodePipeline.ActionOwner)"> <summary> Gets a summary of all AWS CodePipeline action types associated with your account. </summary> <param name="actionOwnerFilter">Filters the list of action types to those created by a specified entity.</param> <returns>The response from the ListActionTypes service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.ListActionTypes(Amazon.CodePipeline.Model.ListActionTypesRequest)"> <summary> Gets a summary of all AWS CodePipeline action types associated with your account. </summary> <param name="request">Container for the necessary parameters to execute the ListActionTypes service method.</param> <returns>The response from the ListActionTypes service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.ListActionTypesAsync(Amazon.CodePipeline.Model.ListActionTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListActionTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the ListActionTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.ListPipelines"> <summary> Gets a summary of all of the pipelines associated with your account. </summary> <returns>The response from the ListPipelines service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.ListPipelines(Amazon.CodePipeline.Model.ListPipelinesRequest)"> <summary> Gets a summary of all of the pipelines associated with your account. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines service method.</param> <returns>The response from the ListPipelines service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.ListPipelinesAsync(Amazon.CodePipeline.Model.ListPipelinesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListPipelines operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PollForJobs(Amazon.CodePipeline.Model.PollForJobsRequest)"> <summary> Returns information about any jobs for AWS CodePipeline to act upon. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the PollForJobs service method.</param> <returns>The response from the PollForJobs service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ActionTypeNotFoundException"> The specified action type cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PollForJobsAsync(Amazon.CodePipeline.Model.PollForJobsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PollForJobs operation. </summary> <param name="request">Container for the necessary parameters to execute the PollForJobs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PollForThirdPartyJobs(Amazon.CodePipeline.Model.PollForThirdPartyJobsRequest)"> <summary> Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the PollForThirdPartyJobs service method.</param> <returns>The response from the PollForThirdPartyJobs service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ActionTypeNotFoundException"> The specified action type cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PollForThirdPartyJobsAsync(Amazon.CodePipeline.Model.PollForThirdPartyJobsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PollForThirdPartyJobs operation. </summary> <param name="request">Container for the necessary parameters to execute the PollForThirdPartyJobs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutActionRevision(Amazon.CodePipeline.Model.PutActionRevisionRequest)"> <summary> Provides information to AWS CodePipeline about new revisions to a source. </summary> <param name="request">Container for the necessary parameters to execute the PutActionRevision service method.</param> <returns>The response from the PutActionRevision service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ActionNotFoundException"> The specified action cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.StageNotFoundException"> The specified stage was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutActionRevisionAsync(Amazon.CodePipeline.Model.PutActionRevisionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutActionRevision operation. </summary> <param name="request">Container for the necessary parameters to execute the PutActionRevision operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutJobFailureResult(System.String,Amazon.CodePipeline.Model.FailureDetails)"> <summary> Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions. </summary> <param name="jobId">The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.</param> <param name="failureDetails">The details about the failure of a job. </param> <returns>The response from the PutJobFailureResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutJobFailureResult(Amazon.CodePipeline.Model.PutJobFailureResultRequest)"> <summary> Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions. </summary> <param name="request">Container for the necessary parameters to execute the PutJobFailureResult service method.</param> <returns>The response from the PutJobFailureResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutJobFailureResultAsync(Amazon.CodePipeline.Model.PutJobFailureResultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutJobFailureResult operation. </summary> <param name="request">Container for the necessary parameters to execute the PutJobFailureResult operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutJobSuccessResult(Amazon.CodePipeline.Model.PutJobSuccessResultRequest)"> <summary> Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions. </summary> <param name="request">Container for the necessary parameters to execute the PutJobSuccessResult service method.</param> <returns>The response from the PutJobSuccessResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutJobSuccessResultAsync(Amazon.CodePipeline.Model.PutJobSuccessResultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutJobSuccessResult operation. </summary> <param name="request">Container for the necessary parameters to execute the PutJobSuccessResult operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutThirdPartyJobFailureResult(System.String,System.String,Amazon.CodePipeline.Model.FailureDetails)"> <summary> Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions. </summary> <param name="jobId">The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.</param> <param name="clientToken">The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</param> <param name="failureDetails">A property of PutThirdPartyJobFailureResultRequest used to execute the PutThirdPartyJobFailureResult service method.</param> <returns>The response from the PutThirdPartyJobFailureResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutThirdPartyJobFailureResult(Amazon.CodePipeline.Model.PutThirdPartyJobFailureResultRequest)"> <summary> Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions. </summary> <param name="request">Container for the necessary parameters to execute the PutThirdPartyJobFailureResult service method.</param> <returns>The response from the PutThirdPartyJobFailureResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutThirdPartyJobFailureResultAsync(Amazon.CodePipeline.Model.PutThirdPartyJobFailureResultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutThirdPartyJobFailureResult operation. </summary> <param name="request">Container for the necessary parameters to execute the PutThirdPartyJobFailureResult operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutThirdPartyJobSuccessResult(Amazon.CodePipeline.Model.PutThirdPartyJobSuccessResultRequest)"> <summary> Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions. </summary> <param name="request">Container for the necessary parameters to execute the PutThirdPartyJobSuccessResult service method.</param> <returns>The response from the PutThirdPartyJobSuccessResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutThirdPartyJobSuccessResultAsync(Amazon.CodePipeline.Model.PutThirdPartyJobSuccessResultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutThirdPartyJobSuccessResult operation. </summary> <param name="request">Container for the necessary parameters to execute the PutThirdPartyJobSuccessResult operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.StartPipelineExecution(System.String)"> <summary> Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. </summary> <param name="name">The name of the pipeline to start.</param> <returns>The response from the StartPipelineExecution service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.StartPipelineExecution(Amazon.CodePipeline.Model.StartPipelineExecutionRequest)"> <summary> Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. </summary> <param name="request">Container for the necessary parameters to execute the StartPipelineExecution service method.</param> <returns>The response from the StartPipelineExecution service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.StartPipelineExecutionAsync(Amazon.CodePipeline.Model.StartPipelineExecutionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartPipelineExecution operation. </summary> <param name="request">Container for the necessary parameters to execute the StartPipelineExecution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.UpdatePipeline(Amazon.CodePipeline.Model.PipelineDeclaration)"> <summary> Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1. </summary> <param name="pipeline">The name of the pipeline to be updated.</param> <returns>The response from the UpdatePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> The specified action declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> The specified gate declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> The specified stage declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStructureException"> The specified structure was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.UpdatePipeline(Amazon.CodePipeline.Model.UpdatePipelineRequest)"> <summary> Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1. </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipeline service method.</param> <returns>The response from the UpdatePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> The specified action declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> The specified gate declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> The specified stage declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStructureException"> The specified structure was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.UpdatePipelineAsync(Amazon.CodePipeline.Model.UpdatePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.CognitoIdentity.AmazonCognitoIdentityClient"> <summary> Implementation for accessing CognitoIdentity Amazon Cognito <para> Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application. </para> <para> Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials. </para> <para> To provide end-user credentials, first make an unsigned call to <a>GetId</a>. If the end user is authenticated with one of the supported identity providers, set the <code>Logins</code> map with the identity provider token. <code>GetId</code> returns a unique identifier for the user. </para> <para> Next, make an unsigned call to <a>GetCredentialsForIdentity</a>. This call expects the same <code>Logins</code> map as the <code>GetId</code> call, as well as the <code>IdentityID</code> originally returned by <code>GetId</code>. Assuming your identity pool has been configured via the <a>SetIdentityPoolRoles</a> operation, <code>GetCredentialsForIdentity</code> will return AWS credentials for your use. If your pool has not been configured with <code>SetIdentityPoolRoles</code>, or if you want to follow legacy flow, make an unsigned call to <a>GetOpenIdToken</a>, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same <code>Logins</code> map as the <code>GetId</code> call, as well as the <code>IdentityID</code> originally returned by <code>GetId</code>. The token returned by <code>GetOpenIdToken</code> can be passed to the STS operation <a href="http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html">AssumeRoleWithWebIdentity</a> to retrieve AWS credentials. </para> <para> If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the <a href="http://docs.aws.amazon.com/mobile/index.html">AWS Mobile SDK Developer Guide</a>. </para> </summary> </member> <member name="T:Amazon.CognitoIdentity.IAmazonCognitoIdentity"> <summary> Interface for accessing CognitoIdentity Amazon Cognito <para> Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application. </para> <para> Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials. </para> <para> To provide end-user credentials, first make an unsigned call to <a>GetId</a>. If the end user is authenticated with one of the supported identity providers, set the <code>Logins</code> map with the identity provider token. <code>GetId</code> returns a unique identifier for the user. </para> <para> Next, make an unsigned call to <a>GetCredentialsForIdentity</a>. This call expects the same <code>Logins</code> map as the <code>GetId</code> call, as well as the <code>IdentityID</code> originally returned by <code>GetId</code>. Assuming your identity pool has been configured via the <a>SetIdentityPoolRoles</a> operation, <code>GetCredentialsForIdentity</code> will return AWS credentials for your use. If your pool has not been configured with <code>SetIdentityPoolRoles</code>, or if you want to follow legacy flow, make an unsigned call to <a>GetOpenIdToken</a>, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same <code>Logins</code> map as the <code>GetId</code> call, as well as the <code>IdentityID</code> originally returned by <code>GetId</code>. The token returned by <code>GetOpenIdToken</code> can be passed to the STS operation <a href="http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html">AssumeRoleWithWebIdentity</a> to retrieve AWS credentials. </para> <para> If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the <a href="http://docs.aws.amazon.com/mobile/index.html">AWS Mobile SDK Developer Guide</a>. </para> </summary> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.CreateIdentityPool(Amazon.CognitoIdentity.Model.CreateIdentityPoolRequest)"> <summary> Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for <code>SupportedLoginProviders</code> are as follows: <ul> <li>Facebook: <code>graph.facebook.com</code> </li> <li>Google: <code>accounts.google.com</code> </li> <li>Amazon: <code>www.amazon.com</code> </li> <li>Twitter: <code>api.twitter.com</code> </li> <li>Digits: <code>www.digits.com</code> </li> </ul> You must use AWS Developer credentials to call this API. </summary> <param name="request">Container for the necessary parameters to execute the CreateIdentityPool service method.</param> <returns>The response from the CreateIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.LimitExceededException"> Thrown when the total number of user pools has exceeded a preset limit. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.CreateIdentityPoolAsync(Amazon.CognitoIdentity.Model.CreateIdentityPoolRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateIdentityPool operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateIdentityPool operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DeleteIdentities(Amazon.CognitoIdentity.Model.DeleteIdentitiesRequest)"> <summary> Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentities service method.</param> <returns>The response from the DeleteIdentities service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DeleteIdentitiesAsync(Amazon.CognitoIdentity.Model.DeleteIdentitiesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteIdentities operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentities operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DeleteIdentityPool(System.String)"> <summary> Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityPoolId">An identity pool ID in the format REGION:GUID.</param> <returns>The response from the DeleteIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DeleteIdentityPool(Amazon.CognitoIdentity.Model.DeleteIdentityPoolRequest)"> <summary> Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentityPool service method.</param> <returns>The response from the DeleteIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DeleteIdentityPoolAsync(Amazon.CognitoIdentity.Model.DeleteIdentityPoolRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteIdentityPool operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentityPool operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DescribeIdentity(System.String)"> <summary> Returns metadata related to the given identity, including when the identity was created and any associated linked logins. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityId">A unique identifier in the format REGION:GUID.</param> <returns>The response from the DescribeIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DescribeIdentity(Amazon.CognitoIdentity.Model.DescribeIdentityRequest)"> <summary> Returns metadata related to the given identity, including when the identity was created and any associated linked logins. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentity service method.</param> <returns>The response from the DescribeIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DescribeIdentityAsync(Amazon.CognitoIdentity.Model.DescribeIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DescribeIdentityPool(System.String)"> <summary> Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityPoolId">An identity pool ID in the format REGION:GUID.</param> <returns>The response from the DescribeIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DescribeIdentityPool(Amazon.CognitoIdentity.Model.DescribeIdentityPoolRequest)"> <summary> Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityPool service method.</param> <returns>The response from the DescribeIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DescribeIdentityPoolAsync(Amazon.CognitoIdentity.Model.DescribeIdentityPoolRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeIdentityPool operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityPool operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetCredentialsForIdentity(System.String)"> <summary> Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="identityId">A unique identifier in the format REGION:GUID.</param> <returns>The response from the GetCredentialsForIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidIdentityPoolConfigurationException"> Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetCredentialsForIdentity(System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="identityId">A unique identifier in the format REGION:GUID.</param> <param name="logins">A set of optional name-value pairs that map provider names to provider tokens.</param> <returns>The response from the GetCredentialsForIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidIdentityPoolConfigurationException"> Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetCredentialsForIdentity(Amazon.CognitoIdentity.Model.GetCredentialsForIdentityRequest)"> <summary> Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetCredentialsForIdentity service method.</param> <returns>The response from the GetCredentialsForIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidIdentityPoolConfigurationException"> Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetCredentialsForIdentityAsync(Amazon.CognitoIdentity.Model.GetCredentialsForIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetCredentialsForIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCredentialsForIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetId(Amazon.CognitoIdentity.Model.GetIdRequest)"> <summary> Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetId service method.</param> <returns>The response from the GetId service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.LimitExceededException"> Thrown when the total number of user pools has exceeded a preset limit. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetIdAsync(Amazon.CognitoIdentity.Model.GetIdRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetId operation. </summary> <param name="request">Container for the necessary parameters to execute the GetId operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetIdentityPoolRoles(System.String)"> <summary> Gets the roles for an identity pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityPoolId">An identity pool ID in the format REGION:GUID.</param> <returns>The response from the GetIdentityPoolRoles service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetIdentityPoolRoles(Amazon.CognitoIdentity.Model.GetIdentityPoolRolesRequest)"> <summary> Gets the roles for an identity pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPoolRoles service method.</param> <returns>The response from the GetIdentityPoolRoles service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetIdentityPoolRolesAsync(Amazon.CognitoIdentity.Model.GetIdentityPoolRolesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetIdentityPoolRoles operation. </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPoolRoles operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetOpenIdToken(System.String)"> <summary> Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by <a>GetId</a>. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link. <para> The OpenId token is valid for 15 minutes. </para> <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="identityId">A unique identifier in the format REGION:GUID.</param> <returns>The response from the GetOpenIdToken service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetOpenIdToken(Amazon.CognitoIdentity.Model.GetOpenIdTokenRequest)"> <summary> Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by <a>GetId</a>. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link. <para> The OpenId token is valid for 15 minutes. </para> <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIdToken service method.</param> <returns>The response from the GetOpenIdToken service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetOpenIdTokenAsync(Amazon.CognitoIdentity.Model.GetOpenIdTokenRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetOpenIdToken operation. </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIdToken operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetOpenIdTokenForDeveloperIdentity(Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityRequest)"> <summary> Registers (or retrieves) a Cognito <code>IdentityId</code> and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the <code>Logins</code> map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users. <para> You can use <code>GetOpenIdTokenForDeveloperIdentity</code> to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the <code>IdentityId</code> should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing <code>IdentityId</code>. This API will create the identity in the specified <code>IdentityPoolId</code>. </para> <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity service method.</param> <returns>The response from the GetOpenIdTokenForDeveloperIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.DeveloperUserAlreadyRegisteredException"> The provided developer user identifier is already registered with Cognito under a different identity ID. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetOpenIdTokenForDeveloperIdentityAsync(Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetOpenIdTokenForDeveloperIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.ListIdentities(Amazon.CognitoIdentity.Model.ListIdentitiesRequest)"> <summary> Lists the identities in a pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListIdentities service method.</param> <returns>The response from the ListIdentities service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.ListIdentitiesAsync(Amazon.CognitoIdentity.Model.ListIdentitiesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListIdentities operation. </summary> <param name="request">Container for the necessary parameters to execute the ListIdentities operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.ListIdentityPools(Amazon.CognitoIdentity.Model.ListIdentityPoolsRequest)"> <summary> Lists all of the Cognito identity pools registered for your account. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPools service method.</param> <returns>The response from the ListIdentityPools service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.ListIdentityPoolsAsync(Amazon.CognitoIdentity.Model.ListIdentityPoolsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListIdentityPools operation. </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPools operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.LookupDeveloperIdentity(Amazon.CognitoIdentity.Model.LookupDeveloperIdentityRequest)"> <summary> Retrieves the <code>IdentityID</code> associated with a <code>DeveloperUserIdentifier</code> or the list of <code>DeveloperUserIdentifier</code>s associated with an <code>IdentityId</code> for an existing identity. Either <code>IdentityID</code> or <code>DeveloperUserIdentifier</code> must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, <code>DeveloperUserIdentifier</code> will be matched against <code>IdentityID</code>. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a <code>ResourceConflictException</code> is thrown. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the LookupDeveloperIdentity service method.</param> <returns>The response from the LookupDeveloperIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.LookupDeveloperIdentityAsync(Amazon.CognitoIdentity.Model.LookupDeveloperIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the LookupDeveloperIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the LookupDeveloperIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.MergeDeveloperIdentities(Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesRequest)"> <summary> Merges two users having different <code>IdentityId</code>s, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (<code>SourceUserIdentifier</code>) with the <code>IdentityId</code> of the <code>DestinationUserIdentifier</code>. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the MergeDeveloperIdentities service method.</param> <returns>The response from the MergeDeveloperIdentities service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.MergeDeveloperIdentitiesAsync(Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the MergeDeveloperIdentities operation. </summary> <param name="request">Container for the necessary parameters to execute the MergeDeveloperIdentities operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.SetIdentityPoolRoles(System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Sets the roles for an identity pool. These roles are used when making calls to <code>GetCredentialsForIdentity</code> action. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityPoolId">An identity pool ID in the format REGION:GUID.</param> <param name="roles">The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.</param> <returns>The response from the SetIdentityPoolRoles service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ConcurrentModificationException"> Thrown if there are parallel requests to modify a resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.SetIdentityPoolRoles(Amazon.CognitoIdentity.Model.SetIdentityPoolRolesRequest)"> <summary> Sets the roles for an identity pool. These roles are used when making calls to <code>GetCredentialsForIdentity</code> action. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityPoolRoles service method.</param> <returns>The response from the SetIdentityPoolRoles service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ConcurrentModificationException"> Thrown if there are parallel requests to modify a resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.SetIdentityPoolRolesAsync(Amazon.CognitoIdentity.Model.SetIdentityPoolRolesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetIdentityPoolRoles operation. </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityPoolRoles operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.UnlinkDeveloperIdentity(Amazon.CognitoIdentity.Model.UnlinkDeveloperIdentityRequest)"> <summary> Unlinks a <code>DeveloperUserIdentifier</code> from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the UnlinkDeveloperIdentity service method.</param> <returns>The response from the UnlinkDeveloperIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.UnlinkDeveloperIdentityAsync(Amazon.CognitoIdentity.Model.UnlinkDeveloperIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UnlinkDeveloperIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the UnlinkDeveloperIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.UnlinkIdentity(Amazon.CognitoIdentity.Model.UnlinkIdentityRequest)"> <summary> Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the UnlinkIdentity service method.</param> <returns>The response from the UnlinkIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.UnlinkIdentityAsync(Amazon.CognitoIdentity.Model.UnlinkIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UnlinkIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the UnlinkIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.UpdateIdentityPool(Amazon.CognitoIdentity.Model.UpdateIdentityPoolRequest)"> <summary> Updates a user pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateIdentityPool service method.</param> <returns>The response from the UpdateIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ConcurrentModificationException"> Thrown if there are parallel requests to modify a resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.UpdateIdentityPoolAsync(Amazon.CognitoIdentity.Model.UpdateIdentityPoolRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateIdentityPool operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateIdentityPool operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor"> <summary> Constructs AmazonCognitoIdentityClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCognitoIdentityClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(Amazon.CognitoIdentity.AmazonCognitoIdentityConfig)"> <summary> Constructs AmazonCognitoIdentityClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCognitoIdentityClient Configuration Object</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CognitoIdentity.AmazonCognitoIdentityConfig)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Credentials and an AmazonCognitoIdentityClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCognitoIdentityClient Configuration Object</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(System.String,System.String,Amazon.CognitoIdentity.AmazonCognitoIdentityConfig)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Access Key ID, AWS Secret Key and an AmazonCognitoIdentityClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCognitoIdentityClient Configuration Object</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(System.String,System.String,System.String,Amazon.CognitoIdentity.AmazonCognitoIdentityConfig)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Access Key ID, AWS Secret Key and an AmazonCognitoIdentityClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCognitoIdentityClient Configuration Object</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.CreateIdentityPool(Amazon.CognitoIdentity.Model.CreateIdentityPoolRequest)"> <summary> Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for <code>SupportedLoginProviders</code> are as follows: <ul> <li>Facebook: <code>graph.facebook.com</code> </li> <li>Google: <code>accounts.google.com</code> </li> <li>Amazon: <code>www.amazon.com</code> </li> <li>Twitter: <code>api.twitter.com</code> </li> <li>Digits: <code>www.digits.com</code> </li> </ul> You must use AWS Developer credentials to call this API. </summary> <param name="request">Container for the necessary parameters to execute the CreateIdentityPool service method.</param> <returns>The response from the CreateIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.LimitExceededException"> Thrown when the total number of user pools has exceeded a preset limit. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.CreateIdentityPoolAsync(Amazon.CognitoIdentity.Model.CreateIdentityPoolRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateIdentityPool operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateIdentityPool operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DeleteIdentities(Amazon.CognitoIdentity.Model.DeleteIdentitiesRequest)"> <summary> Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentities service method.</param> <returns>The response from the DeleteIdentities service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DeleteIdentitiesAsync(Amazon.CognitoIdentity.Model.DeleteIdentitiesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteIdentities operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentities operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DeleteIdentityPool(System.String)"> <summary> Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityPoolId">An identity pool ID in the format REGION:GUID.</param> <returns>The response from the DeleteIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DeleteIdentityPool(Amazon.CognitoIdentity.Model.DeleteIdentityPoolRequest)"> <summary> Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentityPool service method.</param> <returns>The response from the DeleteIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DeleteIdentityPoolAsync(Amazon.CognitoIdentity.Model.DeleteIdentityPoolRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteIdentityPool operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentityPool operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DescribeIdentity(System.String)"> <summary> Returns metadata related to the given identity, including when the identity was created and any associated linked logins. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityId">A unique identifier in the format REGION:GUID.</param> <returns>The response from the DescribeIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DescribeIdentity(Amazon.CognitoIdentity.Model.DescribeIdentityRequest)"> <summary> Returns metadata related to the given identity, including when the identity was created and any associated linked logins. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentity service method.</param> <returns>The response from the DescribeIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DescribeIdentityAsync(Amazon.CognitoIdentity.Model.DescribeIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DescribeIdentityPool(System.String)"> <summary> Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityPoolId">An identity pool ID in the format REGION:GUID.</param> <returns>The response from the DescribeIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DescribeIdentityPool(Amazon.CognitoIdentity.Model.DescribeIdentityPoolRequest)"> <summary> Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityPool service method.</param> <returns>The response from the DescribeIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DescribeIdentityPoolAsync(Amazon.CognitoIdentity.Model.DescribeIdentityPoolRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeIdentityPool operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityPool operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetCredentialsForIdentity(System.String)"> <summary> Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="identityId">A unique identifier in the format REGION:GUID.</param> <returns>The response from the GetCredentialsForIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidIdentityPoolConfigurationException"> Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetCredentialsForIdentity(System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="identityId">A unique identifier in the format REGION:GUID.</param> <param name="logins">A set of optional name-value pairs that map provider names to provider tokens.</param> <returns>The response from the GetCredentialsForIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidIdentityPoolConfigurationException"> Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetCredentialsForIdentity(Amazon.CognitoIdentity.Model.GetCredentialsForIdentityRequest)"> <summary> Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetCredentialsForIdentity service method.</param> <returns>The response from the GetCredentialsForIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidIdentityPoolConfigurationException"> Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetCredentialsForIdentityAsync(Amazon.CognitoIdentity.Model.GetCredentialsForIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetCredentialsForIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCredentialsForIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetId(Amazon.CognitoIdentity.Model.GetIdRequest)"> <summary> Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetId service method.</param> <returns>The response from the GetId service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.LimitExceededException"> Thrown when the total number of user pools has exceeded a preset limit. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetIdAsync(Amazon.CognitoIdentity.Model.GetIdRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetId operation. </summary> <param name="request">Container for the necessary parameters to execute the GetId operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetIdentityPoolRoles(System.String)"> <summary> Gets the roles for an identity pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityPoolId">An identity pool ID in the format REGION:GUID.</param> <returns>The response from the GetIdentityPoolRoles service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetIdentityPoolRoles(Amazon.CognitoIdentity.Model.GetIdentityPoolRolesRequest)"> <summary> Gets the roles for an identity pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPoolRoles service method.</param> <returns>The response from the GetIdentityPoolRoles service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetIdentityPoolRolesAsync(Amazon.CognitoIdentity.Model.GetIdentityPoolRolesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetIdentityPoolRoles operation. </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPoolRoles operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetOpenIdToken(System.String)"> <summary> Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by <a>GetId</a>. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link. <para> The OpenId token is valid for 15 minutes. </para> <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="identityId">A unique identifier in the format REGION:GUID.</param> <returns>The response from the GetOpenIdToken service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetOpenIdToken(Amazon.CognitoIdentity.Model.GetOpenIdTokenRequest)"> <summary> Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by <a>GetId</a>. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link. <para> The OpenId token is valid for 15 minutes. </para> <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIdToken service method.</param> <returns>The response from the GetOpenIdToken service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetOpenIdTokenAsync(Amazon.CognitoIdentity.Model.GetOpenIdTokenRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetOpenIdToken operation. </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIdToken operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetOpenIdTokenForDeveloperIdentity(Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityRequest)"> <summary> Registers (or retrieves) a Cognito <code>IdentityId</code> and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the <code>Logins</code> map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users. <para> You can use <code>GetOpenIdTokenForDeveloperIdentity</code> to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the <code>IdentityId</code> should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing <code>IdentityId</code>. This API will create the identity in the specified <code>IdentityPoolId</code>. </para> <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity service method.</param> <returns>The response from the GetOpenIdTokenForDeveloperIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.DeveloperUserAlreadyRegisteredException"> The provided developer user identifier is already registered with Cognito under a different identity ID. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetOpenIdTokenForDeveloperIdentityAsync(Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetOpenIdTokenForDeveloperIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.ListIdentities(Amazon.CognitoIdentity.Model.ListIdentitiesRequest)"> <summary> Lists the identities in a pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListIdentities service method.</param> <returns>The response from the ListIdentities service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.ListIdentitiesAsync(Amazon.CognitoIdentity.Model.ListIdentitiesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListIdentities operation. </summary> <param name="request">Container for the necessary parameters to execute the ListIdentities operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.ListIdentityPools(Amazon.CognitoIdentity.Model.ListIdentityPoolsRequest)"> <summary> Lists all of the Cognito identity pools registered for your account. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPools service method.</param> <returns>The response from the ListIdentityPools service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.ListIdentityPoolsAsync(Amazon.CognitoIdentity.Model.ListIdentityPoolsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListIdentityPools operation. </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPools operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.LookupDeveloperIdentity(Amazon.CognitoIdentity.Model.LookupDeveloperIdentityRequest)"> <summary> Retrieves the <code>IdentityID</code> associated with a <code>DeveloperUserIdentifier</code> or the list of <code>DeveloperUserIdentifier</code>s associated with an <code>IdentityId</code> for an existing identity. Either <code>IdentityID</code> or <code>DeveloperUserIdentifier</code> must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, <code>DeveloperUserIdentifier</code> will be matched against <code>IdentityID</code>. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a <code>ResourceConflictException</code> is thrown. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the LookupDeveloperIdentity service method.</param> <returns>The response from the LookupDeveloperIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.LookupDeveloperIdentityAsync(Amazon.CognitoIdentity.Model.LookupDeveloperIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the LookupDeveloperIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the LookupDeveloperIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.MergeDeveloperIdentities(Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesRequest)"> <summary> Merges two users having different <code>IdentityId</code>s, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (<code>SourceUserIdentifier</code>) with the <code>IdentityId</code> of the <code>DestinationUserIdentifier</code>. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the MergeDeveloperIdentities service method.</param> <returns>The response from the MergeDeveloperIdentities service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.MergeDeveloperIdentitiesAsync(Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the MergeDeveloperIdentities operation. </summary> <param name="request">Container for the necessary parameters to execute the MergeDeveloperIdentities operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.SetIdentityPoolRoles(System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Sets the roles for an identity pool. These roles are used when making calls to <code>GetCredentialsForIdentity</code> action. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityPoolId">An identity pool ID in the format REGION:GUID.</param> <param name="roles">The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.</param> <returns>The response from the SetIdentityPoolRoles service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ConcurrentModificationException"> Thrown if there are parallel requests to modify a resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.SetIdentityPoolRoles(Amazon.CognitoIdentity.Model.SetIdentityPoolRolesRequest)"> <summary> Sets the roles for an identity pool. These roles are used when making calls to <code>GetCredentialsForIdentity</code> action. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityPoolRoles service method.</param> <returns>The response from the SetIdentityPoolRoles service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ConcurrentModificationException"> Thrown if there are parallel requests to modify a resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.SetIdentityPoolRolesAsync(Amazon.CognitoIdentity.Model.SetIdentityPoolRolesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetIdentityPoolRoles operation. </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityPoolRoles operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.UnlinkDeveloperIdentity(Amazon.CognitoIdentity.Model.UnlinkDeveloperIdentityRequest)"> <summary> Unlinks a <code>DeveloperUserIdentifier</code> from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the UnlinkDeveloperIdentity service method.</param> <returns>The response from the UnlinkDeveloperIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.UnlinkDeveloperIdentityAsync(Amazon.CognitoIdentity.Model.UnlinkDeveloperIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UnlinkDeveloperIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the UnlinkDeveloperIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.UnlinkIdentity(Amazon.CognitoIdentity.Model.UnlinkIdentityRequest)"> <summary> Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the UnlinkIdentity service method.</param> <returns>The response from the UnlinkIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.UnlinkIdentityAsync(Amazon.CognitoIdentity.Model.UnlinkIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UnlinkIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the UnlinkIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.UpdateIdentityPool(Amazon.CognitoIdentity.Model.UpdateIdentityPoolRequest)"> <summary> Updates a user pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateIdentityPool service method.</param> <returns>The response from the UpdateIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ConcurrentModificationException"> Thrown if there are parallel requests to modify a resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.UpdateIdentityPoolAsync(Amazon.CognitoIdentity.Model.UpdateIdentityPoolRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateIdentityPool operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateIdentityPool operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.CognitoSync.AmazonCognitoSyncClient"> <summary> Implementation for accessing CognitoSync Amazon Cognito Sync <para> Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity. </para> <para> With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with <a href="http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html">Amazon Cognito Identity service</a>. </para> <para> If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the <a href="http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-sync.html">Developer Guide for Android</a> and the <a href="http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-sync.html">Developer Guide for iOS</a>. </para> </summary> </member> <member name="T:Amazon.CognitoSync.IAmazonCognitoSync"> <summary> Interface for accessing CognitoSync Amazon Cognito Sync <para> Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity. </para> <para> With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with <a href="http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html">Amazon Cognito Identity service</a>. </para> <para> If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the <a href="http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-sync.html">Developer Guide for Android</a> and the <a href="http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-sync.html">Developer Guide for iOS</a>. </para> </summary> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BulkPublish(Amazon.CognitoSync.Model.BulkPublishRequest)"> <summary> Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the BulkPublish service method.</param> <returns>The response from the BulkPublish service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.AlreadyStreamedException"> An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully. </exception> <exception cref="T:Amazon.CognitoSync.Model.DuplicateRequestException"> An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool. </exception> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BulkPublishAsync(Amazon.CognitoSync.Model.BulkPublishRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BulkPublish operation. </summary> <param name="request">Container for the necessary parameters to execute the BulkPublish operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.DeleteDataset(Amazon.CognitoSync.Model.DeleteDatasetRequest)"> <summary> Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDataset service method.</param> <returns>The response from the DeleteDataset service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceConflictException"> Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.DeleteDatasetAsync(Amazon.CognitoSync.Model.DeleteDatasetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDataset operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDataset operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.DescribeDataset(Amazon.CognitoSync.Model.DescribeDatasetRequest)"> <summary> Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDataset service method.</param> <returns>The response from the DescribeDataset service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.DescribeDatasetAsync(Amazon.CognitoSync.Model.DescribeDatasetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDataset operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDataset operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.DescribeIdentityPoolUsage(System.String)"> <summary> Gets usage details (for example, data storage) about a particular identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="identityPoolId">A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.</param> <returns>The response from the DescribeIdentityPoolUsage service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.DescribeIdentityPoolUsage(Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest)"> <summary> Gets usage details (for example, data storage) about a particular identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityPoolUsage service method.</param> <returns>The response from the DescribeIdentityPoolUsage service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.DescribeIdentityPoolUsageAsync(Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeIdentityPoolUsage operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityPoolUsage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.DescribeIdentityUsage(Amazon.CognitoSync.Model.DescribeIdentityUsageRequest)"> <summary> Gets usage information for an identity, including number of datasets and data usage. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityUsage service method.</param> <returns>The response from the DescribeIdentityUsage service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.DescribeIdentityUsageAsync(Amazon.CognitoSync.Model.DescribeIdentityUsageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeIdentityUsage operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityUsage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.GetBulkPublishDetails(Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest)"> <summary> Get the status of the last BulkPublish operation for an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetBulkPublishDetails service method.</param> <returns>The response from the GetBulkPublishDetails service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.GetBulkPublishDetailsAsync(Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBulkPublishDetails operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBulkPublishDetails operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.GetCognitoEvents(Amazon.CognitoSync.Model.GetCognitoEventsRequest)"> <summary> Gets the events and the corresponding Lambda functions associated with an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetCognitoEvents service method.</param> <returns>The response from the GetCognitoEvents service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.GetCognitoEventsAsync(Amazon.CognitoSync.Model.GetCognitoEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetCognitoEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCognitoEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.GetIdentityPoolConfiguration(System.String)"> <summary> Gets the configuration settings of an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="identityPoolId">A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration.</param> <returns>The response from the GetIdentityPoolConfiguration service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.GetIdentityPoolConfiguration(Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest)"> <summary> Gets the configuration settings of an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPoolConfiguration service method.</param> <returns>The response from the GetIdentityPoolConfiguration service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.GetIdentityPoolConfigurationAsync(Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetIdentityPoolConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPoolConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.ListDatasets(Amazon.CognitoSync.Model.ListDatasetsRequest)"> <summary> Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListDatasets service method.</param> <returns>The response from the ListDatasets service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.ListDatasetsAsync(Amazon.CognitoSync.Model.ListDatasetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDatasets operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDatasets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.ListIdentityPoolUsage(Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest)"> <summary> Gets a list of identity pools registered with Cognito. <para> ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPoolUsage service method.</param> <returns>The response from the ListIdentityPoolUsage service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.ListIdentityPoolUsageAsync(Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListIdentityPoolUsage operation. </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPoolUsage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.ListRecords(Amazon.CognitoSync.Model.ListRecordsRequest)"> <summary> Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListRecords service method.</param> <returns>The response from the ListRecords service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.ListRecordsAsync(Amazon.CognitoSync.Model.ListRecordsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListRecords operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRecords operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.RegisterDevice(Amazon.CognitoSync.Model.RegisterDeviceRequest)"> <summary> Registers a device to receive push sync notifications. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterDevice service method.</param> <returns>The response from the RegisterDevice service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidConfigurationException"> </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.RegisterDeviceAsync(Amazon.CognitoSync.Model.RegisterDeviceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterDevice operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterDevice operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.SetCognitoEvents(Amazon.CognitoSync.Model.SetCognitoEventsRequest)"> <summary> Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetCognitoEvents service method.</param> <returns>The response from the SetCognitoEvents service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.SetCognitoEventsAsync(Amazon.CognitoSync.Model.SetCognitoEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetCognitoEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the SetCognitoEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.SetIdentityPoolConfiguration(Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest)"> <summary> Sets the necessary configuration for push sync. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityPoolConfiguration service method.</param> <returns>The response from the SetIdentityPoolConfiguration service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.ConcurrentModificationException"> Thrown if there are parallel requests to modify a resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.SetIdentityPoolConfigurationAsync(Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetIdentityPoolConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityPoolConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.SubscribeToDataset(Amazon.CognitoSync.Model.SubscribeToDatasetRequest)"> <summary> Subscribes to receive notifications when a dataset is modified by another device. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the SubscribeToDataset service method.</param> <returns>The response from the SubscribeToDataset service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidConfigurationException"> </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.SubscribeToDatasetAsync(Amazon.CognitoSync.Model.SubscribeToDatasetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SubscribeToDataset operation. </summary> <param name="request">Container for the necessary parameters to execute the SubscribeToDataset operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.UnsubscribeFromDataset(Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest)"> <summary> Unsubscribes from receiving notifications when a dataset is modified by another device. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the UnsubscribeFromDataset service method.</param> <returns>The response from the UnsubscribeFromDataset service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidConfigurationException"> </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.UnsubscribeFromDatasetAsync(Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UnsubscribeFromDataset operation. </summary> <param name="request">Container for the necessary parameters to execute the UnsubscribeFromDataset operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.UpdateRecords(Amazon.CognitoSync.Model.UpdateRecordsRequest)"> <summary> Posts updates to records and adds and deletes records for a dataset and user. <para> The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count. </para> <para> For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0. </para> <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateRecords service method.</param> <returns>The response from the UpdateRecords service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidLambdaFunctionOutputException"> The AWS Lambda function returned invalid output or an exception. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.LambdaThrottledException"> AWS Lambda throttled your account, please contact AWS Support </exception> <exception cref="T:Amazon.CognitoSync.Model.LimitExceededException"> Thrown when the limit on the number of objects or operations has been exceeded. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceConflictException"> Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.UpdateRecordsAsync(Amazon.CognitoSync.Model.UpdateRecordsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateRecords operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRecords operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor"> <summary> Constructs AmazonCognitoSyncClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCognitoSyncClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(Amazon.CognitoSync.AmazonCognitoSyncConfig)"> <summary> Constructs AmazonCognitoSyncClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCognitoSyncClient Configuration Object</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCognitoSyncClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCognitoSyncClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CognitoSync.AmazonCognitoSyncConfig)"> <summary> Constructs AmazonCognitoSyncClient with AWS Credentials and an AmazonCognitoSyncClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCognitoSyncClient Configuration Object</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCognitoSyncClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCognitoSyncClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(System.String,System.String,Amazon.CognitoSync.AmazonCognitoSyncConfig)"> <summary> Constructs AmazonCognitoSyncClient with AWS Access Key ID, AWS Secret Key and an AmazonCognitoSyncClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCognitoSyncClient Configuration Object</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCognitoSyncClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCognitoSyncClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(System.String,System.String,System.String,Amazon.CognitoSync.AmazonCognitoSyncConfig)"> <summary> Constructs AmazonCognitoSyncClient with AWS Access Key ID, AWS Secret Key and an AmazonCognitoSyncClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCognitoSyncClient Configuration Object</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BulkPublish(Amazon.CognitoSync.Model.BulkPublishRequest)"> <summary> Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the BulkPublish service method.</param> <returns>The response from the BulkPublish service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.AlreadyStreamedException"> An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully. </exception> <exception cref="T:Amazon.CognitoSync.Model.DuplicateRequestException"> An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool. </exception> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BulkPublishAsync(Amazon.CognitoSync.Model.BulkPublishRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BulkPublish operation. </summary> <param name="request">Container for the necessary parameters to execute the BulkPublish operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.DeleteDataset(Amazon.CognitoSync.Model.DeleteDatasetRequest)"> <summary> Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDataset service method.</param> <returns>The response from the DeleteDataset service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceConflictException"> Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.DeleteDatasetAsync(Amazon.CognitoSync.Model.DeleteDatasetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDataset operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDataset operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.DescribeDataset(Amazon.CognitoSync.Model.DescribeDatasetRequest)"> <summary> Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDataset service method.</param> <returns>The response from the DescribeDataset service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.DescribeDatasetAsync(Amazon.CognitoSync.Model.DescribeDatasetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDataset operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDataset operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.DescribeIdentityPoolUsage(System.String)"> <summary> Gets usage details (for example, data storage) about a particular identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="identityPoolId">A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.</param> <returns>The response from the DescribeIdentityPoolUsage service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.DescribeIdentityPoolUsage(Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest)"> <summary> Gets usage details (for example, data storage) about a particular identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityPoolUsage service method.</param> <returns>The response from the DescribeIdentityPoolUsage service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.DescribeIdentityPoolUsageAsync(Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeIdentityPoolUsage operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityPoolUsage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.DescribeIdentityUsage(Amazon.CognitoSync.Model.DescribeIdentityUsageRequest)"> <summary> Gets usage information for an identity, including number of datasets and data usage. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityUsage service method.</param> <returns>The response from the DescribeIdentityUsage service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.DescribeIdentityUsageAsync(Amazon.CognitoSync.Model.DescribeIdentityUsageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeIdentityUsage operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityUsage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.GetBulkPublishDetails(Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest)"> <summary> Get the status of the last BulkPublish operation for an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetBulkPublishDetails service method.</param> <returns>The response from the GetBulkPublishDetails service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.GetBulkPublishDetailsAsync(Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBulkPublishDetails operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBulkPublishDetails operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.GetCognitoEvents(Amazon.CognitoSync.Model.GetCognitoEventsRequest)"> <summary> Gets the events and the corresponding Lambda functions associated with an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetCognitoEvents service method.</param> <returns>The response from the GetCognitoEvents service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.GetCognitoEventsAsync(Amazon.CognitoSync.Model.GetCognitoEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetCognitoEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCognitoEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.GetIdentityPoolConfiguration(System.String)"> <summary> Gets the configuration settings of an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="identityPoolId">A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration.</param> <returns>The response from the GetIdentityPoolConfiguration service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.GetIdentityPoolConfiguration(Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest)"> <summary> Gets the configuration settings of an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPoolConfiguration service method.</param> <returns>The response from the GetIdentityPoolConfiguration service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.GetIdentityPoolConfigurationAsync(Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetIdentityPoolConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPoolConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.ListDatasets(Amazon.CognitoSync.Model.ListDatasetsRequest)"> <summary> Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListDatasets service method.</param> <returns>The response from the ListDatasets service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.ListDatasetsAsync(Amazon.CognitoSync.Model.ListDatasetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDatasets operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDatasets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.ListIdentityPoolUsage(Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest)"> <summary> Gets a list of identity pools registered with Cognito. <para> ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPoolUsage service method.</param> <returns>The response from the ListIdentityPoolUsage service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.ListIdentityPoolUsageAsync(Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListIdentityPoolUsage operation. </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPoolUsage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.ListRecords(Amazon.CognitoSync.Model.ListRecordsRequest)"> <summary> Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListRecords service method.</param> <returns>The response from the ListRecords service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.ListRecordsAsync(Amazon.CognitoSync.Model.ListRecordsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListRecords operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRecords operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.RegisterDevice(Amazon.CognitoSync.Model.RegisterDeviceRequest)"> <summary> Registers a device to receive push sync notifications. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterDevice service method.</param> <returns>The response from the RegisterDevice service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidConfigurationException"> </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.RegisterDeviceAsync(Amazon.CognitoSync.Model.RegisterDeviceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterDevice operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterDevice operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.SetCognitoEvents(Amazon.CognitoSync.Model.SetCognitoEventsRequest)"> <summary> Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetCognitoEvents service method.</param> <returns>The response from the SetCognitoEvents service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.SetCognitoEventsAsync(Amazon.CognitoSync.Model.SetCognitoEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetCognitoEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the SetCognitoEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.SetIdentityPoolConfiguration(Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest)"> <summary> Sets the necessary configuration for push sync. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityPoolConfiguration service method.</param> <returns>The response from the SetIdentityPoolConfiguration service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.ConcurrentModificationException"> Thrown if there are parallel requests to modify a resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.SetIdentityPoolConfigurationAsync(Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetIdentityPoolConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityPoolConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.SubscribeToDataset(Amazon.CognitoSync.Model.SubscribeToDatasetRequest)"> <summary> Subscribes to receive notifications when a dataset is modified by another device. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the SubscribeToDataset service method.</param> <returns>The response from the SubscribeToDataset service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidConfigurationException"> </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.SubscribeToDatasetAsync(Amazon.CognitoSync.Model.SubscribeToDatasetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SubscribeToDataset operation. </summary> <param name="request">Container for the necessary parameters to execute the SubscribeToDataset operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.UnsubscribeFromDataset(Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest)"> <summary> Unsubscribes from receiving notifications when a dataset is modified by another device. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the UnsubscribeFromDataset service method.</param> <returns>The response from the UnsubscribeFromDataset service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidConfigurationException"> </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.UnsubscribeFromDatasetAsync(Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UnsubscribeFromDataset operation. </summary> <param name="request">Container for the necessary parameters to execute the UnsubscribeFromDataset operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.UpdateRecords(Amazon.CognitoSync.Model.UpdateRecordsRequest)"> <summary> Posts updates to records and adds and deletes records for a dataset and user. <para> The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count. </para> <para> For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0. </para> <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateRecords service method.</param> <returns>The response from the UpdateRecords service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidLambdaFunctionOutputException"> The AWS Lambda function returned invalid output or an exception. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.LambdaThrottledException"> AWS Lambda throttled your account, please contact AWS Support </exception> <exception cref="T:Amazon.CognitoSync.Model.LimitExceededException"> Thrown when the limit on the number of objects or operations has been exceeded. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceConflictException"> Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.UpdateRecordsAsync(Amazon.CognitoSync.Model.UpdateRecordsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateRecords operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRecords operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.CloudFormation.AmazonCloudFormationClient"> <summary> Implementation for accessing CloudFormation AWS CloudFormation <para> AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and repeatedly. AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling to build highly-reliable, highly scalable, cost effective applications without worrying about creating and configuring the underlying AWS infrastructure. </para> <para> With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you. </para> <para> For more information about this product, go to the <a href="http://aws.amazon.com/cloudformation/">CloudFormation Product Page</a>. </para> <para> Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at <a href="http://docs.aws.amazon.com/documentation/">http://docs.aws.amazon.com/documentation/</a>. </para> </summary> </member> <member name="T:Amazon.CloudFormation.IAmazonCloudFormation"> <summary> Interface for accessing CloudFormation AWS CloudFormation <para> AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and repeatedly. AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling to build highly-reliable, highly scalable, cost effective applications without worrying about creating and configuring the underlying AWS infrastructure. </para> <para> With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you. </para> <para> For more information about this product, go to the <a href="http://aws.amazon.com/cloudformation/">CloudFormation Product Page</a>. </para> <para> Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at <a href="http://docs.aws.amazon.com/documentation/">http://docs.aws.amazon.com/documentation/</a>. </para> </summary> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.CancelUpdateStack(Amazon.CloudFormation.Model.CancelUpdateStackRequest)"> <summary> Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. <note>You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.</note> </summary> <param name="request">Container for the necessary parameters to execute the CancelUpdateStack service method.</param> <returns>The response from the CancelUpdateStack service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.CancelUpdateStackAsync(Amazon.CloudFormation.Model.CancelUpdateStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelUpdateStack operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelUpdateStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.ContinueUpdateRollback(Amazon.CloudFormation.Model.ContinueUpdateRollbackRequest)"> <summary> For a specified stack that is in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can manually <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed"> fix the error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again. <para> A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail. </para> </summary> <param name="request">Container for the necessary parameters to execute the ContinueUpdateRollback service method.</param> <returns>The response from the ContinueUpdateRollback service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.ContinueUpdateRollbackAsync(Amazon.CloudFormation.Model.ContinueUpdateRollbackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ContinueUpdateRollback operation. </summary> <param name="request">Container for the necessary parameters to execute the ContinueUpdateRollback operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.CreateStack(Amazon.CloudFormation.Model.CreateStackRequest)"> <summary> Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the <a>DescribeStacks</a> API. </summary> <param name="request">Container for the necessary parameters to execute the CreateStack service method.</param> <returns>The response from the CreateStack service method, as returned by CloudFormation.</returns> <exception cref="T:Amazon.CloudFormation.Model.AlreadyExistsException"> Resource with the name requested already exists. </exception> <exception cref="T:Amazon.CloudFormation.Model.InsufficientCapabilitiesException"> The template contains resources with capabilities that were not specified in the Capabilities parameter. </exception> <exception cref="T:Amazon.CloudFormation.Model.LimitExceededException"> Quota for the resource has already been reached. </exception> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.CreateStackAsync(Amazon.CloudFormation.Model.CreateStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateStack operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DeleteStack(Amazon.CloudFormation.Model.DeleteStackRequest)"> <summary> Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the <a>DescribeStacks</a> API if the deletion has been completed successfully. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStack service method.</param> <returns>The response from the DeleteStack service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DeleteStackAsync(Amazon.CloudFormation.Model.DeleteStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteStack operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeAccountLimits(Amazon.CloudFormation.Model.DescribeAccountLimitsRequest)"> <summary> Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountLimits service method.</param> <returns>The response from the DescribeAccountLimits service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeAccountLimitsAsync(Amazon.CloudFormation.Model.DescribeAccountLimitsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAccountLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountLimits operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeStackEvents(Amazon.CloudFormation.Model.DescribeStackEventsRequest)"> <summary> Returns all stack related events for a specified stack. For more information about a stack's event history, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html">Stacks</a> in the AWS CloudFormation User Guide. <note>You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).</note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackEvents service method.</param> <returns>The response from the DescribeStackEvents service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeStackEventsAsync(Amazon.CloudFormation.Model.DescribeStackEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStackEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeStackResource(Amazon.CloudFormation.Model.DescribeStackResourceRequest)"> <summary> Returns a description of the specified resource in the specified stack. <para> For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackResource service method.</param> <returns>The response from the DescribeStackResource service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeStackResourceAsync(Amazon.CloudFormation.Model.DescribeStackResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStackResource operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeStackResources(Amazon.CloudFormation.Model.DescribeStackResourcesRequest)"> <summary> Returns AWS resource descriptions for running and deleted stacks. If <code>StackName</code> is specified, all the associated resources that are part of the stack are returned. If <code>PhysicalResourceId</code> is specified, the associated resources of the stack that the resource belongs to are returned. <note>Only the first 100 resources will be returned. If your stack has more resources than this, you should use <code>ListStackResources</code> instead.</note> <para> For deleted stacks, <code>DescribeStackResources</code> returns resource information for up to 90 days after the stack has been deleted. </para> <para> You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not both. In addition, you can specify <code>LogicalResourceId</code> to filter the returned result. For more information about resources, the <code>LogicalResourceId</code> and <code>PhysicalResourceId</code>, go to the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/">AWS CloudFormation User Guide</a>. </para> <note>A <code>ValidationError</code> is returned if you specify both <code>StackName</code> and <code>PhysicalResourceId</code> in the same request.</note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackResources service method.</param> <returns>The response from the DescribeStackResources service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeStackResourcesAsync(Amazon.CloudFormation.Model.DescribeStackResourcesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStackResources operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackResources operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeStacks"> <summary> Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. </summary> <returns>The response from the DescribeStacks service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeStacks(Amazon.CloudFormation.Model.DescribeStacksRequest)"> <summary> Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStacks service method.</param> <returns>The response from the DescribeStacks service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeStacksAsync(Amazon.CloudFormation.Model.DescribeStacksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStacks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStacks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.EstimateTemplateCost(Amazon.CloudFormation.Model.EstimateTemplateCostRequest)"> <summary> Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template. </summary> <param name="request">Container for the necessary parameters to execute the EstimateTemplateCost service method.</param> <returns>The response from the EstimateTemplateCost service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.EstimateTemplateCostAsync(Amazon.CloudFormation.Model.EstimateTemplateCostRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EstimateTemplateCost operation. </summary> <param name="request">Container for the necessary parameters to execute the EstimateTemplateCost operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.GetStackPolicy(Amazon.CloudFormation.Model.GetStackPolicyRequest)"> <summary> Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned. </summary> <param name="request">Container for the necessary parameters to execute the GetStackPolicy service method.</param> <returns>The response from the GetStackPolicy service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.GetStackPolicyAsync(Amazon.CloudFormation.Model.GetStackPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetStackPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetStackPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.GetTemplate(Amazon.CloudFormation.Model.GetTemplateRequest)"> <summary> Returns the template body for a specified stack. You can get the template for running or deleted stacks. <para> For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. </para> <note> If the template does not exist, a <code>ValidationError</code> is returned. </note> </summary> <param name="request">Container for the necessary parameters to execute the GetTemplate service method.</param> <returns>The response from the GetTemplate service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.GetTemplateAsync(Amazon.CloudFormation.Model.GetTemplateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetTemplate operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTemplate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.GetTemplateSummary(Amazon.CloudFormation.Model.GetTemplateSummaryRequest)"> <summary> Returns information about a new or existing template. The <code>GetTemplateSummary</code> action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack. <para> You can use the <code>GetTemplateSummary</code> action when you submit a template, or you can get template information for a running or deleted stack. </para> <para> For deleted stacks, <code>GetTemplateSummary</code> returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a <code>ValidationError</code> is returned. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetTemplateSummary service method.</param> <returns>The response from the GetTemplateSummary service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.GetTemplateSummaryAsync(Amazon.CloudFormation.Model.GetTemplateSummaryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetTemplateSummary operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTemplateSummary operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.ListStackResources(Amazon.CloudFormation.Model.ListStackResourcesRequest)"> <summary> Returns descriptions of all resources of the specified stack. <para> For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListStackResources service method.</param> <returns>The response from the ListStackResources service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.ListStackResourcesAsync(Amazon.CloudFormation.Model.ListStackResourcesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListStackResources operation. </summary> <param name="request">Container for the necessary parameters to execute the ListStackResources operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.ListStacks"> <summary> Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted). </summary> <returns>The response from the ListStacks service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.ListStacks(Amazon.CloudFormation.Model.ListStacksRequest)"> <summary> Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted). </summary> <param name="request">Container for the necessary parameters to execute the ListStacks service method.</param> <returns>The response from the ListStacks service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.ListStacksAsync(Amazon.CloudFormation.Model.ListStacksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListStacks operation. </summary> <param name="request">Container for the necessary parameters to execute the ListStacks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.SetStackPolicy(Amazon.CloudFormation.Model.SetStackPolicyRequest)"> <summary> Sets a stack policy for a specified stack. </summary> <param name="request">Container for the necessary parameters to execute the SetStackPolicy service method.</param> <returns>The response from the SetStackPolicy service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.SetStackPolicyAsync(Amazon.CloudFormation.Model.SetStackPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetStackPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the SetStackPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.SignalResource(Amazon.CloudFormation.Model.SignalResourceRequest)"> <summary> Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance. </summary> <param name="request">Container for the necessary parameters to execute the SignalResource service method.</param> <returns>The response from the SignalResource service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.SignalResourceAsync(Amazon.CloudFormation.Model.SignalResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SignalResource operation. </summary> <param name="request">Container for the necessary parameters to execute the SignalResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.UpdateStack(Amazon.CloudFormation.Model.UpdateStackRequest)"> <summary> Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action. <para> To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action. </para> <para> For more information about creating an update template, updating a stack, and monitoring the progress of the update, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html">Updating a Stack</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateStack service method.</param> <returns>The response from the UpdateStack service method, as returned by CloudFormation.</returns> <exception cref="T:Amazon.CloudFormation.Model.InsufficientCapabilitiesException"> The template contains resources with capabilities that were not specified in the Capabilities parameter. </exception> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.UpdateStackAsync(Amazon.CloudFormation.Model.UpdateStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateStack operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.ValidateTemplate"> <summary> Validates a specified template. </summary> <returns>The response from the ValidateTemplate service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.ValidateTemplate(Amazon.CloudFormation.Model.ValidateTemplateRequest)"> <summary> Validates a specified template. </summary> <param name="request">Container for the necessary parameters to execute the ValidateTemplate service method.</param> <returns>The response from the ValidateTemplate service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.ValidateTemplateAsync(Amazon.CloudFormation.Model.ValidateTemplateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ValidateTemplate operation. </summary> <param name="request">Container for the necessary parameters to execute the ValidateTemplate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor"> <summary> Constructs AmazonCloudFormationClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudFormationClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(Amazon.CloudFormation.AmazonCloudFormationConfig)"> <summary> Constructs AmazonCloudFormationClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudFormationClient Configuration Object</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudFormationClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudFormationClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudFormation.AmazonCloudFormationConfig)"> <summary> Constructs AmazonCloudFormationClient with AWS Credentials and an AmazonCloudFormationClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudFormationClient Configuration Object</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(System.String,System.String,Amazon.CloudFormation.AmazonCloudFormationConfig)"> <summary> Constructs AmazonCloudFormationClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudFormationClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudFormationClient Configuration Object</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(System.String,System.String,System.String,Amazon.CloudFormation.AmazonCloudFormationConfig)"> <summary> Constructs AmazonCloudFormationClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudFormationClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudFormationClient Configuration Object</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.CancelUpdateStack(Amazon.CloudFormation.Model.CancelUpdateStackRequest)"> <summary> Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. <note>You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.</note> </summary> <param name="request">Container for the necessary parameters to execute the CancelUpdateStack service method.</param> <returns>The response from the CancelUpdateStack service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.CancelUpdateStackAsync(Amazon.CloudFormation.Model.CancelUpdateStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelUpdateStack operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelUpdateStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ContinueUpdateRollback(Amazon.CloudFormation.Model.ContinueUpdateRollbackRequest)"> <summary> For a specified stack that is in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can manually <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed"> fix the error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again. <para> A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail. </para> </summary> <param name="request">Container for the necessary parameters to execute the ContinueUpdateRollback service method.</param> <returns>The response from the ContinueUpdateRollback service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ContinueUpdateRollbackAsync(Amazon.CloudFormation.Model.ContinueUpdateRollbackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ContinueUpdateRollback operation. </summary> <param name="request">Container for the necessary parameters to execute the ContinueUpdateRollback operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.CreateStack(Amazon.CloudFormation.Model.CreateStackRequest)"> <summary> Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the <a>DescribeStacks</a> API. </summary> <param name="request">Container for the necessary parameters to execute the CreateStack service method.</param> <returns>The response from the CreateStack service method, as returned by CloudFormation.</returns> <exception cref="T:Amazon.CloudFormation.Model.AlreadyExistsException"> Resource with the name requested already exists. </exception> <exception cref="T:Amazon.CloudFormation.Model.InsufficientCapabilitiesException"> The template contains resources with capabilities that were not specified in the Capabilities parameter. </exception> <exception cref="T:Amazon.CloudFormation.Model.LimitExceededException"> Quota for the resource has already been reached. </exception> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.CreateStackAsync(Amazon.CloudFormation.Model.CreateStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateStack operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DeleteStack(Amazon.CloudFormation.Model.DeleteStackRequest)"> <summary> Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the <a>DescribeStacks</a> API if the deletion has been completed successfully. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStack service method.</param> <returns>The response from the DeleteStack service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DeleteStackAsync(Amazon.CloudFormation.Model.DeleteStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteStack operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeAccountLimits(Amazon.CloudFormation.Model.DescribeAccountLimitsRequest)"> <summary> Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountLimits service method.</param> <returns>The response from the DescribeAccountLimits service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeAccountLimitsAsync(Amazon.CloudFormation.Model.DescribeAccountLimitsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAccountLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountLimits operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStackEvents(Amazon.CloudFormation.Model.DescribeStackEventsRequest)"> <summary> Returns all stack related events for a specified stack. For more information about a stack's event history, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html">Stacks</a> in the AWS CloudFormation User Guide. <note>You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).</note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackEvents service method.</param> <returns>The response from the DescribeStackEvents service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStackEventsAsync(Amazon.CloudFormation.Model.DescribeStackEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStackEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStackResource(Amazon.CloudFormation.Model.DescribeStackResourceRequest)"> <summary> Returns a description of the specified resource in the specified stack. <para> For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackResource service method.</param> <returns>The response from the DescribeStackResource service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStackResourceAsync(Amazon.CloudFormation.Model.DescribeStackResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStackResource operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStackResources(Amazon.CloudFormation.Model.DescribeStackResourcesRequest)"> <summary> Returns AWS resource descriptions for running and deleted stacks. If <code>StackName</code> is specified, all the associated resources that are part of the stack are returned. If <code>PhysicalResourceId</code> is specified, the associated resources of the stack that the resource belongs to are returned. <note>Only the first 100 resources will be returned. If your stack has more resources than this, you should use <code>ListStackResources</code> instead.</note> <para> For deleted stacks, <code>DescribeStackResources</code> returns resource information for up to 90 days after the stack has been deleted. </para> <para> You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not both. In addition, you can specify <code>LogicalResourceId</code> to filter the returned result. For more information about resources, the <code>LogicalResourceId</code> and <code>PhysicalResourceId</code>, go to the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/">AWS CloudFormation User Guide</a>. </para> <note>A <code>ValidationError</code> is returned if you specify both <code>StackName</code> and <code>PhysicalResourceId</code> in the same request.</note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackResources service method.</param> <returns>The response from the DescribeStackResources service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStackResourcesAsync(Amazon.CloudFormation.Model.DescribeStackResourcesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStackResources operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackResources operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStacks"> <summary> Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. </summary> <returns>The response from the DescribeStacks service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStacks(Amazon.CloudFormation.Model.DescribeStacksRequest)"> <summary> Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStacks service method.</param> <returns>The response from the DescribeStacks service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStacksAsync(Amazon.CloudFormation.Model.DescribeStacksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStacks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStacks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EstimateTemplateCost(Amazon.CloudFormation.Model.EstimateTemplateCostRequest)"> <summary> Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template. </summary> <param name="request">Container for the necessary parameters to execute the EstimateTemplateCost service method.</param> <returns>The response from the EstimateTemplateCost service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EstimateTemplateCostAsync(Amazon.CloudFormation.Model.EstimateTemplateCostRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EstimateTemplateCost operation. </summary> <param name="request">Container for the necessary parameters to execute the EstimateTemplateCost operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.GetStackPolicy(Amazon.CloudFormation.Model.GetStackPolicyRequest)"> <summary> Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned. </summary> <param name="request">Container for the necessary parameters to execute the GetStackPolicy service method.</param> <returns>The response from the GetStackPolicy service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.GetStackPolicyAsync(Amazon.CloudFormation.Model.GetStackPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetStackPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetStackPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.GetTemplate(Amazon.CloudFormation.Model.GetTemplateRequest)"> <summary> Returns the template body for a specified stack. You can get the template for running or deleted stacks. <para> For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. </para> <note> If the template does not exist, a <code>ValidationError</code> is returned. </note> </summary> <param name="request">Container for the necessary parameters to execute the GetTemplate service method.</param> <returns>The response from the GetTemplate service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.GetTemplateAsync(Amazon.CloudFormation.Model.GetTemplateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetTemplate operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTemplate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.GetTemplateSummary(Amazon.CloudFormation.Model.GetTemplateSummaryRequest)"> <summary> Returns information about a new or existing template. The <code>GetTemplateSummary</code> action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack. <para> You can use the <code>GetTemplateSummary</code> action when you submit a template, or you can get template information for a running or deleted stack. </para> <para> For deleted stacks, <code>GetTemplateSummary</code> returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a <code>ValidationError</code> is returned. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetTemplateSummary service method.</param> <returns>The response from the GetTemplateSummary service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.GetTemplateSummaryAsync(Amazon.CloudFormation.Model.GetTemplateSummaryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetTemplateSummary operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTemplateSummary operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ListStackResources(Amazon.CloudFormation.Model.ListStackResourcesRequest)"> <summary> Returns descriptions of all resources of the specified stack. <para> For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListStackResources service method.</param> <returns>The response from the ListStackResources service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ListStackResourcesAsync(Amazon.CloudFormation.Model.ListStackResourcesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListStackResources operation. </summary> <param name="request">Container for the necessary parameters to execute the ListStackResources operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ListStacks"> <summary> Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted). </summary> <returns>The response from the ListStacks service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ListStacks(Amazon.CloudFormation.Model.ListStacksRequest)"> <summary> Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted). </summary> <param name="request">Container for the necessary parameters to execute the ListStacks service method.</param> <returns>The response from the ListStacks service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ListStacksAsync(Amazon.CloudFormation.Model.ListStacksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListStacks operation. </summary> <param name="request">Container for the necessary parameters to execute the ListStacks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.SetStackPolicy(Amazon.CloudFormation.Model.SetStackPolicyRequest)"> <summary> Sets a stack policy for a specified stack. </summary> <param name="request">Container for the necessary parameters to execute the SetStackPolicy service method.</param> <returns>The response from the SetStackPolicy service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.SetStackPolicyAsync(Amazon.CloudFormation.Model.SetStackPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetStackPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the SetStackPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.SignalResource(Amazon.CloudFormation.Model.SignalResourceRequest)"> <summary> Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance. </summary> <param name="request">Container for the necessary parameters to execute the SignalResource service method.</param> <returns>The response from the SignalResource service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.SignalResourceAsync(Amazon.CloudFormation.Model.SignalResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SignalResource operation. </summary> <param name="request">Container for the necessary parameters to execute the SignalResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.UpdateStack(Amazon.CloudFormation.Model.UpdateStackRequest)"> <summary> Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action. <para> To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action. </para> <para> For more information about creating an update template, updating a stack, and monitoring the progress of the update, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html">Updating a Stack</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateStack service method.</param> <returns>The response from the UpdateStack service method, as returned by CloudFormation.</returns> <exception cref="T:Amazon.CloudFormation.Model.InsufficientCapabilitiesException"> The template contains resources with capabilities that were not specified in the Capabilities parameter. </exception> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.UpdateStackAsync(Amazon.CloudFormation.Model.UpdateStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateStack operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ValidateTemplate"> <summary> Validates a specified template. </summary> <returns>The response from the ValidateTemplate service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ValidateTemplate(Amazon.CloudFormation.Model.ValidateTemplateRequest)"> <summary> Validates a specified template. </summary> <param name="request">Container for the necessary parameters to execute the ValidateTemplate service method.</param> <returns>The response from the ValidateTemplate service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ValidateTemplateAsync(Amazon.CloudFormation.Model.ValidateTemplateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ValidateTemplate operation. </summary> <param name="request">Container for the necessary parameters to execute the ValidateTemplate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.CloudFront.AmazonCloudFrontClient"> <summary> Implementation for accessing CloudFront </summary> </member> <member name="T:Amazon.CloudFront.IAmazonCloudFront"> <summary> Interface for accessing CloudFront </summary> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.CreateCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityRequest)"> <summary> Create a new origin access identity. </summary> <param name="request">Container for the necessary parameters to execute the CreateCloudFrontOriginAccessIdentity service method.</param> <returns>The response from the CreateCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityAlreadyExistsException"> If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error. </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCloudFrontOriginAccessIdentitiesException"> Processing your request would cause you to exceed the maximum number of origin access identities allowed. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.CreateCloudFrontOriginAccessIdentityAsync(Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCloudFrontOriginAccessIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCloudFrontOriginAccessIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.CreateDistribution(Amazon.CloudFront.Model.CreateDistributionRequest)"> <summary> Create a new distribution. </summary> <param name="request">Container for the necessary parameters to execute the CreateDistribution service method.</param> <returns>The response from the CreateDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CNAMEAlreadyExistsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.DistributionAlreadyExistsException"> The caller reference you attempted to create the distribution with is associated with another distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidDefaultRootObjectException"> The default root object file name is too big or contains an invalid character. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidErrorCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidForwardCookiesException"> Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidGeoRestrictionParameterException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidHeadersForS3OriginException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidLocationCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidMinimumProtocolVersionException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginAccessIdentityException"> The origin access identity is not valid or doesn't exist. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginException"> The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidProtocolSettingsException"> You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI). </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidRelativePathException"> The relative path is too big, is not URL-encoded, or does not begin with a slash (/). </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidRequiredProtocolException"> This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidResponseCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidTTLOrderException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidViewerCertificateException"> </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchOriginException"> No origin exists with the specified Origin Id. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCacheBehaviorsException"> You cannot create anymore cache behaviors for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCertificatesException"> You cannot create anymore custom ssl certificates. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCookieNamesInWhiteListException"> Your request contains more cookie names in the whitelist than are allowed per cache behavior. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyDistributionCNAMEsException"> Your request contains more CNAMEs than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyDistributionsException"> Processing your request would cause you to exceed the maximum number of distributions allowed. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyHeadersInForwardedValuesException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyOriginsException"> You cannot create anymore origins for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyTrustedSignersException"> Your request contains more trusted signers than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TrustedSignerDoesNotExistException"> One or more of your trusted signers do not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.CreateDistributionAsync(Amazon.CloudFront.Model.CreateDistributionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDistribution operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDistribution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.CreateInvalidation(Amazon.CloudFront.Model.CreateInvalidationRequest)"> <summary> Create a new invalidation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInvalidation service method.</param> <returns>The response from the CreateInvalidation service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.BatchTooLargeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyInvalidationsInProgressException"> You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.CreateInvalidationAsync(Amazon.CloudFront.Model.CreateInvalidationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateInvalidation operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInvalidation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.CreateStreamingDistribution(Amazon.CloudFront.Model.CreateStreamingDistributionRequest)"> <summary> Create a new streaming distribution. </summary> <param name="request">Container for the necessary parameters to execute the CreateStreamingDistribution service method.</param> <returns>The response from the CreateStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CNAMEAlreadyExistsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginAccessIdentityException"> The origin access identity is not valid or doesn't exist. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginException"> The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket. </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.StreamingDistributionAlreadyExistsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyStreamingDistributionCNAMEsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyStreamingDistributionsException"> Processing your request would cause you to exceed the maximum number of streaming distributions allowed. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyTrustedSignersException"> Your request contains more trusted signers than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TrustedSignerDoesNotExistException"> One or more of your trusted signers do not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.CreateStreamingDistributionAsync(Amazon.CloudFront.Model.CreateStreamingDistributionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateStreamingDistribution operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateStreamingDistribution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.DeleteCloudFrontOriginAccessIdentity"> <summary> Delete an origin access identity. </summary> <returns>The response from the DeleteCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityInUseException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.DeleteCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.DeleteCloudFrontOriginAccessIdentityRequest)"> <summary> Delete an origin access identity. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCloudFrontOriginAccessIdentity service method.</param> <returns>The response from the DeleteCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityInUseException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.DeleteCloudFrontOriginAccessIdentityAsync(Amazon.CloudFront.Model.DeleteCloudFrontOriginAccessIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCloudFrontOriginAccessIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCloudFrontOriginAccessIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.DeleteDistribution"> <summary> Delete a distribution. </summary> <returns>The response from the DeleteDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.DistributionNotDisabledException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.DeleteDistribution(Amazon.CloudFront.Model.DeleteDistributionRequest)"> <summary> Delete a distribution. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDistribution service method.</param> <returns>The response from the DeleteDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.DistributionNotDisabledException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.DeleteDistributionAsync(Amazon.CloudFront.Model.DeleteDistributionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDistribution operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDistribution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.DeleteStreamingDistribution"> <summary> Delete a streaming distribution. </summary> <returns>The response from the DeleteStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> <exception cref="T:Amazon.CloudFront.Model.StreamingDistributionNotDisabledException"> </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.DeleteStreamingDistribution(Amazon.CloudFront.Model.DeleteStreamingDistributionRequest)"> <summary> Delete a streaming distribution. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStreamingDistribution service method.</param> <returns>The response from the DeleteStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> <exception cref="T:Amazon.CloudFront.Model.StreamingDistributionNotDisabledException"> </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.DeleteStreamingDistributionAsync(Amazon.CloudFront.Model.DeleteStreamingDistributionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteStreamingDistribution operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStreamingDistribution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetCloudFrontOriginAccessIdentity"> <summary> Get the information about an origin access identity. </summary> <returns>The response from the GetCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityRequest)"> <summary> Get the information about an origin access identity. </summary> <param name="request">Container for the necessary parameters to execute the GetCloudFrontOriginAccessIdentity service method.</param> <returns>The response from the GetCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetCloudFrontOriginAccessIdentityAsync(Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetCloudFrontOriginAccessIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCloudFrontOriginAccessIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetCloudFrontOriginAccessIdentityConfig"> <summary> Get the configuration information about an origin access identity. </summary> <returns>The response from the GetCloudFrontOriginAccessIdentityConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetCloudFrontOriginAccessIdentityConfig(Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigRequest)"> <summary> Get the configuration information about an origin access identity. </summary> <param name="request">Container for the necessary parameters to execute the GetCloudFrontOriginAccessIdentityConfig service method.</param> <returns>The response from the GetCloudFrontOriginAccessIdentityConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetCloudFrontOriginAccessIdentityConfigAsync(Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetCloudFrontOriginAccessIdentityConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCloudFrontOriginAccessIdentityConfig operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetDistribution"> <summary> Get the information about a distribution. </summary> <returns>The response from the GetDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetDistribution(Amazon.CloudFront.Model.GetDistributionRequest)"> <summary> Get the information about a distribution. </summary> <param name="request">Container for the necessary parameters to execute the GetDistribution service method.</param> <returns>The response from the GetDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetDistributionAsync(Amazon.CloudFront.Model.GetDistributionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDistribution operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDistribution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetDistributionConfig"> <summary> Get the configuration information about a distribution. </summary> <returns>The response from the GetDistributionConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetDistributionConfig(Amazon.CloudFront.Model.GetDistributionConfigRequest)"> <summary> Get the configuration information about a distribution. </summary> <param name="request">Container for the necessary parameters to execute the GetDistributionConfig service method.</param> <returns>The response from the GetDistributionConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetDistributionConfigAsync(Amazon.CloudFront.Model.GetDistributionConfigRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDistributionConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDistributionConfig operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetInvalidation(Amazon.CloudFront.Model.GetInvalidationRequest)"> <summary> Get the information about an invalidation. </summary> <param name="request">Container for the necessary parameters to execute the GetInvalidation service method.</param> <returns>The response from the GetInvalidation service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchInvalidationException"> The specified invalidation does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetInvalidationAsync(Amazon.CloudFront.Model.GetInvalidationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetInvalidation operation. </summary> <param name="request">Container for the necessary parameters to execute the GetInvalidation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetStreamingDistribution"> <summary> Get the information about a streaming distribution. </summary> <returns>The response from the GetStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetStreamingDistribution(Amazon.CloudFront.Model.GetStreamingDistributionRequest)"> <summary> Get the information about a streaming distribution. </summary> <param name="request">Container for the necessary parameters to execute the GetStreamingDistribution service method.</param> <returns>The response from the GetStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetStreamingDistributionAsync(Amazon.CloudFront.Model.GetStreamingDistributionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetStreamingDistribution operation. </summary> <param name="request">Container for the necessary parameters to execute the GetStreamingDistribution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetStreamingDistributionConfig"> <summary> Get the configuration information about a streaming distribution. </summary> <returns>The response from the GetStreamingDistributionConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetStreamingDistributionConfig(Amazon.CloudFront.Model.GetStreamingDistributionConfigRequest)"> <summary> Get the configuration information about a streaming distribution. </summary> <param name="request">Container for the necessary parameters to execute the GetStreamingDistributionConfig service method.</param> <returns>The response from the GetStreamingDistributionConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetStreamingDistributionConfigAsync(Amazon.CloudFront.Model.GetStreamingDistributionConfigRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetStreamingDistributionConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the GetStreamingDistributionConfig operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.ListCloudFrontOriginAccessIdentities"> <summary> List origin access identities. </summary> <returns>The response from the ListCloudFrontOriginAccessIdentities service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.ListCloudFrontOriginAccessIdentities(Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesRequest)"> <summary> List origin access identities. </summary> <param name="request">Container for the necessary parameters to execute the ListCloudFrontOriginAccessIdentities service method.</param> <returns>The response from the ListCloudFrontOriginAccessIdentities service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.ListCloudFrontOriginAccessIdentitiesAsync(Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListCloudFrontOriginAccessIdentities operation. </summary> <param name="request">Container for the necessary parameters to execute the ListCloudFrontOriginAccessIdentities operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.ListDistributions"> <summary> List distributions. </summary> <returns>The response from the ListDistributions service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.ListDistributions(Amazon.CloudFront.Model.ListDistributionsRequest)"> <summary> List distributions. </summary> <param name="request">Container for the necessary parameters to execute the ListDistributions service method.</param> <returns>The response from the ListDistributions service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.ListDistributionsAsync(Amazon.CloudFront.Model.ListDistributionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDistributions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDistributions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.ListInvalidations(Amazon.CloudFront.Model.ListInvalidationsRequest)"> <summary> List invalidation batches. </summary> <param name="request">Container for the necessary parameters to execute the ListInvalidations service method.</param> <returns>The response from the ListInvalidations service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.ListInvalidationsAsync(Amazon.CloudFront.Model.ListInvalidationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListInvalidations operation. </summary> <param name="request">Container for the necessary parameters to execute the ListInvalidations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.ListStreamingDistributions"> <summary> List streaming distributions. </summary> <returns>The response from the ListStreamingDistributions service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.ListStreamingDistributions(Amazon.CloudFront.Model.ListStreamingDistributionsRequest)"> <summary> List streaming distributions. </summary> <param name="request">Container for the necessary parameters to execute the ListStreamingDistributions service method.</param> <returns>The response from the ListStreamingDistributions service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.ListStreamingDistributionsAsync(Amazon.CloudFront.Model.ListStreamingDistributionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListStreamingDistributions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListStreamingDistributions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.UpdateCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityRequest)"> <summary> Update an origin access identity. </summary> <param name="request">Container for the necessary parameters to execute the UpdateCloudFrontOriginAccessIdentity service method.</param> <returns>The response from the UpdateCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.IllegalUpdateException"> Origin and CallerReference cannot be updated. </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.UpdateCloudFrontOriginAccessIdentityAsync(Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateCloudFrontOriginAccessIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateCloudFrontOriginAccessIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.UpdateDistribution(Amazon.CloudFront.Model.UpdateDistributionRequest)"> <summary> Update a distribution. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDistribution service method.</param> <returns>The response from the UpdateDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CNAMEAlreadyExistsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.IllegalUpdateException"> Origin and CallerReference cannot be updated. </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidDefaultRootObjectException"> The default root object file name is too big or contains an invalid character. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidErrorCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidForwardCookiesException"> Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidGeoRestrictionParameterException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidHeadersForS3OriginException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidLocationCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidMinimumProtocolVersionException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginAccessIdentityException"> The origin access identity is not valid or doesn't exist. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidRelativePathException"> The relative path is too big, is not URL-encoded, or does not begin with a slash (/). </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidRequiredProtocolException"> This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidResponseCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidTTLOrderException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidViewerCertificateException"> </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchOriginException"> No origin exists with the specified Origin Id. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCacheBehaviorsException"> You cannot create anymore cache behaviors for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCertificatesException"> You cannot create anymore custom ssl certificates. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCookieNamesInWhiteListException"> Your request contains more cookie names in the whitelist than are allowed per cache behavior. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyDistributionCNAMEsException"> Your request contains more CNAMEs than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyHeadersInForwardedValuesException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyOriginsException"> You cannot create anymore origins for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyTrustedSignersException"> Your request contains more trusted signers than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TrustedSignerDoesNotExistException"> One or more of your trusted signers do not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.UpdateDistributionAsync(Amazon.CloudFront.Model.UpdateDistributionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDistribution operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDistribution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.UpdateStreamingDistribution(Amazon.CloudFront.Model.UpdateStreamingDistributionRequest)"> <summary> Update a streaming distribution. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStreamingDistribution service method.</param> <returns>The response from the UpdateStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CNAMEAlreadyExistsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.IllegalUpdateException"> Origin and CallerReference cannot be updated. </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginAccessIdentityException"> The origin access identity is not valid or doesn't exist. </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyStreamingDistributionCNAMEsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyTrustedSignersException"> Your request contains more trusted signers than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TrustedSignerDoesNotExistException"> One or more of your trusted signers do not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.UpdateStreamingDistributionAsync(Amazon.CloudFront.Model.UpdateStreamingDistributionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateStreamingDistribution operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStreamingDistribution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor"> <summary> Constructs AmazonCloudFrontClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudFrontClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(Amazon.CloudFront.AmazonCloudFrontConfig)"> <summary> Constructs AmazonCloudFrontClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudFrontClient Configuration Object</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudFrontClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudFrontClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudFront.AmazonCloudFrontConfig)"> <summary> Constructs AmazonCloudFrontClient with AWS Credentials and an AmazonCloudFrontClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudFrontClient Configuration Object</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudFrontClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudFrontClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(System.String,System.String,Amazon.CloudFront.AmazonCloudFrontConfig)"> <summary> Constructs AmazonCloudFrontClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudFrontClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudFrontClient Configuration Object</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudFrontClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudFrontClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(System.String,System.String,System.String,Amazon.CloudFront.AmazonCloudFrontConfig)"> <summary> Constructs AmazonCloudFrontClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudFrontClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudFrontClient Configuration Object</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.CreateCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityRequest)"> <summary> Create a new origin access identity. </summary> <param name="request">Container for the necessary parameters to execute the CreateCloudFrontOriginAccessIdentity service method.</param> <returns>The response from the CreateCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityAlreadyExistsException"> If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error. </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCloudFrontOriginAccessIdentitiesException"> Processing your request would cause you to exceed the maximum number of origin access identities allowed. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.CreateCloudFrontOriginAccessIdentityAsync(Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCloudFrontOriginAccessIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCloudFrontOriginAccessIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.CreateDistribution(Amazon.CloudFront.Model.CreateDistributionRequest)"> <summary> Create a new distribution. </summary> <param name="request">Container for the necessary parameters to execute the CreateDistribution service method.</param> <returns>The response from the CreateDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CNAMEAlreadyExistsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.DistributionAlreadyExistsException"> The caller reference you attempted to create the distribution with is associated with another distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidDefaultRootObjectException"> The default root object file name is too big or contains an invalid character. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidErrorCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidForwardCookiesException"> Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidGeoRestrictionParameterException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidHeadersForS3OriginException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidLocationCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidMinimumProtocolVersionException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginAccessIdentityException"> The origin access identity is not valid or doesn't exist. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginException"> The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidProtocolSettingsException"> You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI). </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidRelativePathException"> The relative path is too big, is not URL-encoded, or does not begin with a slash (/). </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidRequiredProtocolException"> This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidResponseCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidTTLOrderException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidViewerCertificateException"> </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchOriginException"> No origin exists with the specified Origin Id. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCacheBehaviorsException"> You cannot create anymore cache behaviors for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCertificatesException"> You cannot create anymore custom ssl certificates. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCookieNamesInWhiteListException"> Your request contains more cookie names in the whitelist than are allowed per cache behavior. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyDistributionCNAMEsException"> Your request contains more CNAMEs than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyDistributionsException"> Processing your request would cause you to exceed the maximum number of distributions allowed. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyHeadersInForwardedValuesException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyOriginsException"> You cannot create anymore origins for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyTrustedSignersException"> Your request contains more trusted signers than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TrustedSignerDoesNotExistException"> One or more of your trusted signers do not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.CreateDistributionAsync(Amazon.CloudFront.Model.CreateDistributionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDistribution operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDistribution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.CreateInvalidation(Amazon.CloudFront.Model.CreateInvalidationRequest)"> <summary> Create a new invalidation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInvalidation service method.</param> <returns>The response from the CreateInvalidation service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.BatchTooLargeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyInvalidationsInProgressException"> You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.CreateInvalidationAsync(Amazon.CloudFront.Model.CreateInvalidationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateInvalidation operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInvalidation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.CreateStreamingDistribution(Amazon.CloudFront.Model.CreateStreamingDistributionRequest)"> <summary> Create a new streaming distribution. </summary> <param name="request">Container for the necessary parameters to execute the CreateStreamingDistribution service method.</param> <returns>The response from the CreateStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CNAMEAlreadyExistsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginAccessIdentityException"> The origin access identity is not valid or doesn't exist. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginException"> The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket. </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.StreamingDistributionAlreadyExistsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyStreamingDistributionCNAMEsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyStreamingDistributionsException"> Processing your request would cause you to exceed the maximum number of streaming distributions allowed. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyTrustedSignersException"> Your request contains more trusted signers than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TrustedSignerDoesNotExistException"> One or more of your trusted signers do not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.CreateStreamingDistributionAsync(Amazon.CloudFront.Model.CreateStreamingDistributionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateStreamingDistribution operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateStreamingDistribution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.DeleteCloudFrontOriginAccessIdentity"> <summary> Delete an origin access identity. </summary> <returns>The response from the DeleteCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityInUseException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.DeleteCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.DeleteCloudFrontOriginAccessIdentityRequest)"> <summary> Delete an origin access identity. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCloudFrontOriginAccessIdentity service method.</param> <returns>The response from the DeleteCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityInUseException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.DeleteCloudFrontOriginAccessIdentityAsync(Amazon.CloudFront.Model.DeleteCloudFrontOriginAccessIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCloudFrontOriginAccessIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCloudFrontOriginAccessIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.DeleteDistribution"> <summary> Delete a distribution. </summary> <returns>The response from the DeleteDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.DistributionNotDisabledException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.DeleteDistribution(Amazon.CloudFront.Model.DeleteDistributionRequest)"> <summary> Delete a distribution. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDistribution service method.</param> <returns>The response from the DeleteDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.DistributionNotDisabledException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.DeleteDistributionAsync(Amazon.CloudFront.Model.DeleteDistributionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDistribution operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDistribution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.DeleteStreamingDistribution"> <summary> Delete a streaming distribution. </summary> <returns>The response from the DeleteStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> <exception cref="T:Amazon.CloudFront.Model.StreamingDistributionNotDisabledException"> </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.DeleteStreamingDistribution(Amazon.CloudFront.Model.DeleteStreamingDistributionRequest)"> <summary> Delete a streaming distribution. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStreamingDistribution service method.</param> <returns>The response from the DeleteStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> <exception cref="T:Amazon.CloudFront.Model.StreamingDistributionNotDisabledException"> </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.DeleteStreamingDistributionAsync(Amazon.CloudFront.Model.DeleteStreamingDistributionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteStreamingDistribution operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStreamingDistribution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetCloudFrontOriginAccessIdentity"> <summary> Get the information about an origin access identity. </summary> <returns>The response from the GetCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityRequest)"> <summary> Get the information about an origin access identity. </summary> <param name="request">Container for the necessary parameters to execute the GetCloudFrontOriginAccessIdentity service method.</param> <returns>The response from the GetCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetCloudFrontOriginAccessIdentityAsync(Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetCloudFrontOriginAccessIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCloudFrontOriginAccessIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetCloudFrontOriginAccessIdentityConfig"> <summary> Get the configuration information about an origin access identity. </summary> <returns>The response from the GetCloudFrontOriginAccessIdentityConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetCloudFrontOriginAccessIdentityConfig(Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigRequest)"> <summary> Get the configuration information about an origin access identity. </summary> <param name="request">Container for the necessary parameters to execute the GetCloudFrontOriginAccessIdentityConfig service method.</param> <returns>The response from the GetCloudFrontOriginAccessIdentityConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetCloudFrontOriginAccessIdentityConfigAsync(Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetCloudFrontOriginAccessIdentityConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCloudFrontOriginAccessIdentityConfig operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetDistribution"> <summary> Get the information about a distribution. </summary> <returns>The response from the GetDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetDistribution(Amazon.CloudFront.Model.GetDistributionRequest)"> <summary> Get the information about a distribution. </summary> <param name="request">Container for the necessary parameters to execute the GetDistribution service method.</param> <returns>The response from the GetDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetDistributionAsync(Amazon.CloudFront.Model.GetDistributionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDistribution operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDistribution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetDistributionConfig"> <summary> Get the configuration information about a distribution. </summary> <returns>The response from the GetDistributionConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetDistributionConfig(Amazon.CloudFront.Model.GetDistributionConfigRequest)"> <summary> Get the configuration information about a distribution. </summary> <param name="request">Container for the necessary parameters to execute the GetDistributionConfig service method.</param> <returns>The response from the GetDistributionConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetDistributionConfigAsync(Amazon.CloudFront.Model.GetDistributionConfigRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDistributionConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDistributionConfig operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetInvalidation(Amazon.CloudFront.Model.GetInvalidationRequest)"> <summary> Get the information about an invalidation. </summary> <param name="request">Container for the necessary parameters to execute the GetInvalidation service method.</param> <returns>The response from the GetInvalidation service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchInvalidationException"> The specified invalidation does not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetInvalidationAsync(Amazon.CloudFront.Model.GetInvalidationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetInvalidation operation. </summary> <param name="request">Container for the necessary parameters to execute the GetInvalidation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetStreamingDistribution"> <summary> Get the information about a streaming distribution. </summary> <returns>The response from the GetStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetStreamingDistribution(Amazon.CloudFront.Model.GetStreamingDistributionRequest)"> <summary> Get the information about a streaming distribution. </summary> <param name="request">Container for the necessary parameters to execute the GetStreamingDistribution service method.</param> <returns>The response from the GetStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetStreamingDistributionAsync(Amazon.CloudFront.Model.GetStreamingDistributionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetStreamingDistribution operation. </summary> <param name="request">Container for the necessary parameters to execute the GetStreamingDistribution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetStreamingDistributionConfig"> <summary> Get the configuration information about a streaming distribution. </summary> <returns>The response from the GetStreamingDistributionConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetStreamingDistributionConfig(Amazon.CloudFront.Model.GetStreamingDistributionConfigRequest)"> <summary> Get the configuration information about a streaming distribution. </summary> <param name="request">Container for the necessary parameters to execute the GetStreamingDistributionConfig service method.</param> <returns>The response from the GetStreamingDistributionConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.GetStreamingDistributionConfigAsync(Amazon.CloudFront.Model.GetStreamingDistributionConfigRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetStreamingDistributionConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the GetStreamingDistributionConfig operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.ListCloudFrontOriginAccessIdentities"> <summary> List origin access identities. </summary> <returns>The response from the ListCloudFrontOriginAccessIdentities service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.ListCloudFrontOriginAccessIdentities(Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesRequest)"> <summary> List origin access identities. </summary> <param name="request">Container for the necessary parameters to execute the ListCloudFrontOriginAccessIdentities service method.</param> <returns>The response from the ListCloudFrontOriginAccessIdentities service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.ListCloudFrontOriginAccessIdentitiesAsync(Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListCloudFrontOriginAccessIdentities operation. </summary> <param name="request">Container for the necessary parameters to execute the ListCloudFrontOriginAccessIdentities operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.ListDistributions"> <summary> List distributions. </summary> <returns>The response from the ListDistributions service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.ListDistributions(Amazon.CloudFront.Model.ListDistributionsRequest)"> <summary> List distributions. </summary> <param name="request">Container for the necessary parameters to execute the ListDistributions service method.</param> <returns>The response from the ListDistributions service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.ListDistributionsAsync(Amazon.CloudFront.Model.ListDistributionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDistributions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDistributions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.ListInvalidations(Amazon.CloudFront.Model.ListInvalidationsRequest)"> <summary> List invalidation batches. </summary> <param name="request">Container for the necessary parameters to execute the ListInvalidations service method.</param> <returns>The response from the ListInvalidations service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.ListInvalidationsAsync(Amazon.CloudFront.Model.ListInvalidationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListInvalidations operation. </summary> <param name="request">Container for the necessary parameters to execute the ListInvalidations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.ListStreamingDistributions"> <summary> List streaming distributions. </summary> <returns>The response from the ListStreamingDistributions service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.ListStreamingDistributions(Amazon.CloudFront.Model.ListStreamingDistributionsRequest)"> <summary> List streaming distributions. </summary> <param name="request">Container for the necessary parameters to execute the ListStreamingDistributions service method.</param> <returns>The response from the ListStreamingDistributions service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.ListStreamingDistributionsAsync(Amazon.CloudFront.Model.ListStreamingDistributionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListStreamingDistributions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListStreamingDistributions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.UpdateCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityRequest)"> <summary> Update an origin access identity. </summary> <param name="request">Container for the necessary parameters to execute the UpdateCloudFrontOriginAccessIdentity service method.</param> <returns>The response from the UpdateCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.IllegalUpdateException"> Origin and CallerReference cannot be updated. </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.UpdateCloudFrontOriginAccessIdentityAsync(Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateCloudFrontOriginAccessIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateCloudFrontOriginAccessIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.UpdateDistribution(Amazon.CloudFront.Model.UpdateDistributionRequest)"> <summary> Update a distribution. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDistribution service method.</param> <returns>The response from the UpdateDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CNAMEAlreadyExistsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.IllegalUpdateException"> Origin and CallerReference cannot be updated. </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidDefaultRootObjectException"> The default root object file name is too big or contains an invalid character. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidErrorCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidForwardCookiesException"> Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidGeoRestrictionParameterException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidHeadersForS3OriginException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidLocationCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidMinimumProtocolVersionException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginAccessIdentityException"> The origin access identity is not valid or doesn't exist. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidRelativePathException"> The relative path is too big, is not URL-encoded, or does not begin with a slash (/). </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidRequiredProtocolException"> This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidResponseCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidTTLOrderException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidViewerCertificateException"> </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchOriginException"> No origin exists with the specified Origin Id. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCacheBehaviorsException"> You cannot create anymore cache behaviors for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCertificatesException"> You cannot create anymore custom ssl certificates. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCookieNamesInWhiteListException"> Your request contains more cookie names in the whitelist than are allowed per cache behavior. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyDistributionCNAMEsException"> Your request contains more CNAMEs than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyHeadersInForwardedValuesException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyOriginsException"> You cannot create anymore origins for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyTrustedSignersException"> Your request contains more trusted signers than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TrustedSignerDoesNotExistException"> One or more of your trusted signers do not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.UpdateDistributionAsync(Amazon.CloudFront.Model.UpdateDistributionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDistribution operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDistribution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.UpdateStreamingDistribution(Amazon.CloudFront.Model.UpdateStreamingDistributionRequest)"> <summary> Update a streaming distribution. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStreamingDistribution service method.</param> <returns>The response from the UpdateStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CNAMEAlreadyExistsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.IllegalUpdateException"> Origin and CallerReference cannot be updated. </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginAccessIdentityException"> The origin access identity is not valid or doesn't exist. </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyStreamingDistributionCNAMEsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyTrustedSignersException"> Your request contains more trusted signers than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TrustedSignerDoesNotExistException"> One or more of your trusted signers do not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.UpdateStreamingDistributionAsync(Amazon.CloudFront.Model.UpdateStreamingDistributionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateStreamingDistribution operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStreamingDistribution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient"> <summary> Implementation for accessing CloudSearchDomain You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents. <para> The endpoints for submitting <code>UploadDocuments</code>, <code>Search</code>, and <code>Suggest</code> requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint. </para> <para> For more information, see the <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide">Amazon CloudSearch Developer Guide</a>. </para> </summary> </member> <member name="T:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain"> <summary> Interface for accessing CloudSearchDomain You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents. <para> The endpoints for submitting <code>UploadDocuments</code>, <code>Search</code>, and <code>Suggest</code> requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint. </para> <para> For more information, see the <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide">Amazon CloudSearch Developer Guide</a>. </para> </summary> </member> <member name="M:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain.Search(Amazon.CloudSearchDomain.Model.SearchRequest)"> <summary> Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers: <ul> <li><code>simple</code>: search all <code>text</code> and <code>text-array</code> fields for the specified string. Search for phrases, individual terms, and prefixes. </li> <li><code>structured</code>: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.</li> <li><code>lucene</code>: specify search criteria using the Apache Lucene query parser syntax.</li> <li><code>dismax</code>: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.</li> </ul> <para> For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html">Searching Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> <para> The endpoint for submitting <code>Search</code> requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> </summary> <param name="request">Container for the necessary parameters to execute the Search service method.</param> <returns>The response from the Search service method, as returned by CloudSearchDomain.</returns> <exception cref="T:Amazon.CloudSearchDomain.Model.SearchException"> Information about any problems encountered while processing a search request. </exception> </member> <member name="M:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain.SearchAsync(Amazon.CloudSearchDomain.Model.SearchRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Search operation. </summary> <param name="request">Container for the necessary parameters to execute the Search operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain.Suggest(Amazon.CloudSearchDomain.Model.SuggestRequest)"> <summary> Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match. <para> For more information about configuring suggesters and retrieving suggestions, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html">Getting Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> <para> The endpoint for submitting <code>Suggest</code> requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> </summary> <param name="request">Container for the necessary parameters to execute the Suggest service method.</param> <returns>The response from the Suggest service method, as returned by CloudSearchDomain.</returns> <exception cref="T:Amazon.CloudSearchDomain.Model.SearchException"> Information about any problems encountered while processing a search request. </exception> </member> <member name="M:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain.SuggestAsync(Amazon.CloudSearchDomain.Model.SuggestRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Suggest operation. </summary> <param name="request">Container for the necessary parameters to execute the Suggest operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain.UploadDocuments(Amazon.CloudSearchDomain.Model.UploadDocumentsRequest)"> <summary> Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service. <para> The endpoint for submitting <code>UploadDocuments</code> requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> <para> For more information about formatting your data for Amazon CloudSearch, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html">Preparing Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. For more information about uploading data for indexing, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/uploading-data.html">Uploading Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UploadDocuments service method.</param> <returns>The response from the UploadDocuments service method, as returned by CloudSearchDomain.</returns> <exception cref="T:Amazon.CloudSearchDomain.Model.DocumentServiceException"> Information about any problems encountered while processing an upload request. </exception> </member> <member name="M:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain.UploadDocumentsAsync(Amazon.CloudSearchDomain.Model.UploadDocumentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UploadDocuments operation. </summary> <param name="request">Container for the necessary parameters to execute the UploadDocuments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.Search(Amazon.CloudSearchDomain.Model.SearchRequest)"> <summary> Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers: <ul> <li><code>simple</code>: search all <code>text</code> and <code>text-array</code> fields for the specified string. Search for phrases, individual terms, and prefixes. </li> <li><code>structured</code>: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.</li> <li><code>lucene</code>: specify search criteria using the Apache Lucene query parser syntax.</li> <li><code>dismax</code>: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.</li> </ul> <para> For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html">Searching Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> <para> The endpoint for submitting <code>Search</code> requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> </summary> <param name="request">Container for the necessary parameters to execute the Search service method.</param> <returns>The response from the Search service method, as returned by CloudSearchDomain.</returns> <exception cref="T:Amazon.CloudSearchDomain.Model.SearchException"> Information about any problems encountered while processing a search request. </exception> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.SearchAsync(Amazon.CloudSearchDomain.Model.SearchRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Search operation. </summary> <param name="request">Container for the necessary parameters to execute the Search operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.Suggest(Amazon.CloudSearchDomain.Model.SuggestRequest)"> <summary> Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match. <para> For more information about configuring suggesters and retrieving suggestions, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html">Getting Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> <para> The endpoint for submitting <code>Suggest</code> requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> </summary> <param name="request">Container for the necessary parameters to execute the Suggest service method.</param> <returns>The response from the Suggest service method, as returned by CloudSearchDomain.</returns> <exception cref="T:Amazon.CloudSearchDomain.Model.SearchException"> Information about any problems encountered while processing a search request. </exception> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.SuggestAsync(Amazon.CloudSearchDomain.Model.SuggestRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Suggest operation. </summary> <param name="request">Container for the necessary parameters to execute the Suggest operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.UploadDocuments(Amazon.CloudSearchDomain.Model.UploadDocumentsRequest)"> <summary> Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service. <para> The endpoint for submitting <code>UploadDocuments</code> requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> <para> For more information about formatting your data for Amazon CloudSearch, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html">Preparing Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. For more information about uploading data for indexing, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/uploading-data.html">Uploading Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UploadDocuments service method.</param> <returns>The response from the UploadDocuments service method, as returned by CloudSearchDomain.</returns> <exception cref="T:Amazon.CloudSearchDomain.Model.DocumentServiceException"> Information about any problems encountered while processing an upload request. </exception> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.UploadDocumentsAsync(Amazon.CloudSearchDomain.Model.UploadDocumentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UploadDocuments operation. </summary> <param name="request">Container for the necessary parameters to execute the UploadDocuments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor"> <summary> Constructs AmazonCloudSearchDomainClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(System.String)"> <summary> Constructs AmazonCloudSearchDomainClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="serviceUrl">The URL of the search or document service.</param> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(Amazon.CloudSearchDomain.AmazonCloudSearchDomainConfig)"> <summary> Constructs AmazonCloudSearchDomainClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudSearchDomainClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(System.String,Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudSearchDomainClient with AWS Credentials </summary> <param name="serviceUrl">The URL of the search or document service.</param> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudSearchDomain.AmazonCloudSearchDomainConfig)"> <summary> Constructs AmazonCloudSearchDomainClient with AWS Credentials and an AmazonCloudSearchDomainClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudSearchDomainClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudSearchDomainClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudSearchDomainClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="serviceUrl">The URL of the search or document service.</param> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(System.String,System.String,Amazon.CloudSearchDomain.AmazonCloudSearchDomainConfig)"> <summary> Constructs AmazonCloudSearchDomainClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudSearchDomainClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudSearchDomainClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(System.String,System.String,System.String,System.String)"> <summary> Constructs AmazonCloudSearchDomainClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="serviceUrl">The URL of the search or document service.</param> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(System.String,System.String,System.String,Amazon.CloudSearchDomain.AmazonCloudSearchDomainConfig)"> <summary> Constructs AmazonCloudSearchDomainClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudSearchDomainClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudSearchDomainClient Configuration Object</param> </member> <member name="T:Amazon.CloudSearch.AmazonCloudSearchClient"> <summary> Implementation for accessing CloudSearch Amazon CloudSearch Configuration Service <para> You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action. </para> <para> The endpoint for configuration service requests is region-specific: cloudsearch.<i>region</i>.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region" target="_blank">Regions and Endpoints</a>. </para> </summary> </member> <member name="T:Amazon.CloudSearch.IAmazonCloudSearch"> <summary> Interface for accessing CloudSearch Amazon CloudSearch Configuration Service <para> You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action. </para> <para> The endpoint for configuration service requests is region-specific: cloudsearch.<i>region</i>.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region" target="_blank">Regions and Endpoints</a>. </para> </summary> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BuildSuggesters(Amazon.CloudSearch.Model.BuildSuggestersRequest)"> <summary> Indexes the search suggestions. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters">Configuring Suggesters</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the BuildSuggesters service method.</param> <returns>The response from the BuildSuggesters service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BuildSuggestersAsync(Amazon.CloudSearch.Model.BuildSuggestersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BuildSuggesters operation. </summary> <param name="request">Container for the necessary parameters to execute the BuildSuggesters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.CreateDomain(Amazon.CloudSearch.Model.CreateDomainRequest)"> <summary> Creates a new search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html" target="_blank">Creating a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain service method.</param> <returns>The response from the CreateDomain service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.CreateDomainAsync(Amazon.CloudSearch.Model.CreateDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DefineAnalysisScheme(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest)"> <summary> Configures an analysis scheme that can be applied to a <code>text</code> or <code>text-array</code> field to define language-specific text processing options. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DefineAnalysisScheme service method.</param> <returns>The response from the DefineAnalysisScheme service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DefineAnalysisSchemeAsync(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DefineAnalysisScheme operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineAnalysisScheme operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DefineExpression(Amazon.CloudSearch.Model.DefineExpressionRequest)"> <summary> Configures an <code><a>Expression</a></code> for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DefineExpression service method.</param> <returns>The response from the DefineExpression service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DefineExpressionAsync(Amazon.CloudSearch.Model.DefineExpressionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DefineExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineExpression operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DefineIndexField(Amazon.CloudSearch.Model.DefineIndexFieldRequest)"> <summary> Configures an <code><a>IndexField</a></code> for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the <code><a>IndexFieldType</a></code>. If the field exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DefineIndexField service method.</param> <returns>The response from the DefineIndexField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DefineIndexFieldAsync(Amazon.CloudSearch.Model.DefineIndexFieldRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DefineIndexField operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineIndexField operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DefineSuggester(Amazon.CloudSearch.Model.DefineSuggesterRequest)"> <summary> Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DefineSuggester service method.</param> <returns>The response from the DefineSuggester service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DefineSuggesterAsync(Amazon.CloudSearch.Model.DefineSuggesterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DefineSuggester operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineSuggester operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DeleteAnalysisScheme(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest)"> <summary> Deletes an analysis scheme. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAnalysisScheme service method.</param> <returns>The response from the DeleteAnalysisScheme service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DeleteAnalysisSchemeAsync(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAnalysisScheme operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAnalysisScheme operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DeleteDomain(Amazon.CloudSearch.Model.DeleteDomainRequest)"> <summary> Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html" target="_blank">Deleting a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain service method.</param> <returns>The response from the DeleteDomain service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DeleteDomainAsync(Amazon.CloudSearch.Model.DeleteDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DeleteExpression(Amazon.CloudSearch.Model.DeleteExpressionRequest)"> <summary> Removes an <code><a>Expression</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteExpression service method.</param> <returns>The response from the DeleteExpression service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DeleteExpressionAsync(Amazon.CloudSearch.Model.DeleteExpressionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteExpression operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DeleteIndexField(Amazon.CloudSearch.Model.DeleteIndexFieldRequest)"> <summary> Removes an <code><a>IndexField</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIndexField service method.</param> <returns>The response from the DeleteIndexField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DeleteIndexFieldAsync(Amazon.CloudSearch.Model.DeleteIndexFieldRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteIndexField operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIndexField operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DeleteSuggester(Amazon.CloudSearch.Model.DeleteSuggesterRequest)"> <summary> Deletes a suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSuggester service method.</param> <returns>The response from the DeleteSuggester service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DeleteSuggesterAsync(Amazon.CloudSearch.Model.DeleteSuggesterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSuggester operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSuggester operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeAnalysisSchemes(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest)"> <summary> Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a <code>text</code> field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAnalysisSchemes service method.</param> <returns>The response from the DescribeAnalysisSchemes service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeAnalysisSchemesAsync(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAnalysisSchemes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAnalysisSchemes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeAvailabilityOptions(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest)"> <summary> Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityOptions service method.</param> <returns>The response from the DescribeAvailabilityOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.DisabledOperationException"> The request was rejected because it attempted an operation which is not enabled. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeAvailabilityOptionsAsync(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAvailabilityOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeDomains"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&amp;q.parser=structured&amp;size=0</code>. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <returns>The response from the DescribeDomains service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeDomains(Amazon.CloudSearch.Model.DescribeDomainsRequest)"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&amp;q.parser=structured&amp;size=0</code>. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomains service method.</param> <returns>The response from the DescribeDomains service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeDomainsAsync(Amazon.CloudSearch.Model.DescribeDomainsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDomains operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomains operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeExpressions(Amazon.CloudSearch.Model.DescribeExpressionsRequest)"> <summary> Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExpressions service method.</param> <returns>The response from the DescribeExpressions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeExpressionsAsync(Amazon.CloudSearch.Model.DescribeExpressionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeExpressions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExpressions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeIndexFields(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest)"> <summary> Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Domain Information</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIndexFields service method.</param> <returns>The response from the DescribeIndexFields service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeIndexFieldsAsync(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeIndexFields operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIndexFields operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeScalingParameters(Amazon.CloudSearch.Model.DescribeScalingParametersRequest)"> <summary> Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingParameters service method.</param> <returns>The response from the DescribeScalingParameters service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeScalingParametersAsync(Amazon.CloudSearch.Model.DescribeScalingParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeScalingParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeServiceAccessPolicies(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest)"> <summary> Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceAccessPolicies service method.</param> <returns>The response from the DescribeServiceAccessPolicies service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeServiceAccessPoliciesAsync(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceAccessPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeSuggesters(Amazon.CloudSearch.Model.DescribeSuggestersRequest)"> <summary> Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSuggesters service method.</param> <returns>The response from the DescribeSuggesters service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeSuggestersAsync(Amazon.CloudSearch.Model.DescribeSuggestersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSuggesters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSuggesters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.IndexDocuments(Amazon.CloudSearch.Model.IndexDocumentsRequest)"> <summary> Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose <a>OptionStatus</a> is <code>RequiresIndexDocuments</code>. </summary> <param name="request">Container for the necessary parameters to execute the IndexDocuments service method.</param> <returns>The response from the IndexDocuments service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.IndexDocumentsAsync(Amazon.CloudSearch.Model.IndexDocumentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the IndexDocuments operation. </summary> <param name="request">Container for the necessary parameters to execute the IndexDocuments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.ListDomainNames"> <summary> Lists all search domains owned by an account. </summary> <returns>The response from the ListDomainNames service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.ListDomainNames(Amazon.CloudSearch.Model.ListDomainNamesRequest)"> <summary> Lists all search domains owned by an account. </summary> <param name="request">Container for the necessary parameters to execute the ListDomainNames service method.</param> <returns>The response from the ListDomainNames service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.ListDomainNamesAsync(Amazon.CloudSearch.Model.ListDomainNamesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDomainNames operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDomainNames operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.UpdateAvailabilityOptions(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest)"> <summary> Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAvailabilityOptions service method.</param> <returns>The response from the UpdateAvailabilityOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.DisabledOperationException"> The request was rejected because it attempted an operation which is not enabled. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.UpdateAvailabilityOptionsAsync(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAvailabilityOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAvailabilityOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.UpdateScalingParameters(Amazon.CloudSearch.Model.UpdateScalingParametersRequest)"> <summary> Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateScalingParameters service method.</param> <returns>The response from the UpdateScalingParameters service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.UpdateScalingParametersAsync(Amazon.CloudSearch.Model.UpdateScalingParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateScalingParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateScalingParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.UpdateServiceAccessPolicies(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest)"> <summary> Configures the access rules that control access to the domain's document and search endpoints. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank"> Configuring Access for an Amazon CloudSearch Domain</a>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServiceAccessPolicies service method.</param> <returns>The response from the UpdateServiceAccessPolicies service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.UpdateServiceAccessPoliciesAsync(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateServiceAccessPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServiceAccessPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor"> <summary> Constructs AmazonCloudSearchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudSearchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(Amazon.CloudSearch.AmazonCloudSearchConfig)"> <summary> Constructs AmazonCloudSearchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudSearchClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudSearchClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudSearchClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudSearch.AmazonCloudSearchConfig)"> <summary> Constructs AmazonCloudSearchClient with AWS Credentials and an AmazonCloudSearchClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudSearchClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(System.String,System.String,Amazon.CloudSearch.AmazonCloudSearchConfig)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudSearchClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudSearchClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(System.String,System.String,System.String,Amazon.CloudSearch.AmazonCloudSearchConfig)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudSearchClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudSearchClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BuildSuggesters(Amazon.CloudSearch.Model.BuildSuggestersRequest)"> <summary> Indexes the search suggestions. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters">Configuring Suggesters</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the BuildSuggesters service method.</param> <returns>The response from the BuildSuggesters service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BuildSuggestersAsync(Amazon.CloudSearch.Model.BuildSuggestersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BuildSuggesters operation. </summary> <param name="request">Container for the necessary parameters to execute the BuildSuggesters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.CreateDomain(Amazon.CloudSearch.Model.CreateDomainRequest)"> <summary> Creates a new search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html" target="_blank">Creating a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain service method.</param> <returns>The response from the CreateDomain service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.CreateDomainAsync(Amazon.CloudSearch.Model.CreateDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DefineAnalysisScheme(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest)"> <summary> Configures an analysis scheme that can be applied to a <code>text</code> or <code>text-array</code> field to define language-specific text processing options. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DefineAnalysisScheme service method.</param> <returns>The response from the DefineAnalysisScheme service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DefineAnalysisSchemeAsync(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DefineAnalysisScheme operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineAnalysisScheme operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DefineExpression(Amazon.CloudSearch.Model.DefineExpressionRequest)"> <summary> Configures an <code><a>Expression</a></code> for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DefineExpression service method.</param> <returns>The response from the DefineExpression service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DefineExpressionAsync(Amazon.CloudSearch.Model.DefineExpressionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DefineExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineExpression operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DefineIndexField(Amazon.CloudSearch.Model.DefineIndexFieldRequest)"> <summary> Configures an <code><a>IndexField</a></code> for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the <code><a>IndexFieldType</a></code>. If the field exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DefineIndexField service method.</param> <returns>The response from the DefineIndexField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DefineIndexFieldAsync(Amazon.CloudSearch.Model.DefineIndexFieldRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DefineIndexField operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineIndexField operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DefineSuggester(Amazon.CloudSearch.Model.DefineSuggesterRequest)"> <summary> Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DefineSuggester service method.</param> <returns>The response from the DefineSuggester service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DefineSuggesterAsync(Amazon.CloudSearch.Model.DefineSuggesterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DefineSuggester operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineSuggester operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteAnalysisScheme(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest)"> <summary> Deletes an analysis scheme. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAnalysisScheme service method.</param> <returns>The response from the DeleteAnalysisScheme service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteAnalysisSchemeAsync(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAnalysisScheme operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAnalysisScheme operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteDomain(Amazon.CloudSearch.Model.DeleteDomainRequest)"> <summary> Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html" target="_blank">Deleting a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain service method.</param> <returns>The response from the DeleteDomain service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteDomainAsync(Amazon.CloudSearch.Model.DeleteDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteExpression(Amazon.CloudSearch.Model.DeleteExpressionRequest)"> <summary> Removes an <code><a>Expression</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteExpression service method.</param> <returns>The response from the DeleteExpression service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteExpressionAsync(Amazon.CloudSearch.Model.DeleteExpressionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteExpression operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteIndexField(Amazon.CloudSearch.Model.DeleteIndexFieldRequest)"> <summary> Removes an <code><a>IndexField</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIndexField service method.</param> <returns>The response from the DeleteIndexField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteIndexFieldAsync(Amazon.CloudSearch.Model.DeleteIndexFieldRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteIndexField operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIndexField operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteSuggester(Amazon.CloudSearch.Model.DeleteSuggesterRequest)"> <summary> Deletes a suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSuggester service method.</param> <returns>The response from the DeleteSuggester service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteSuggesterAsync(Amazon.CloudSearch.Model.DeleteSuggesterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSuggester operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSuggester operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeAnalysisSchemes(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest)"> <summary> Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a <code>text</code> field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAnalysisSchemes service method.</param> <returns>The response from the DescribeAnalysisSchemes service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeAnalysisSchemesAsync(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAnalysisSchemes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAnalysisSchemes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeAvailabilityOptions(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest)"> <summary> Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityOptions service method.</param> <returns>The response from the DescribeAvailabilityOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.DisabledOperationException"> The request was rejected because it attempted an operation which is not enabled. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeAvailabilityOptionsAsync(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAvailabilityOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeDomains"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&amp;q.parser=structured&amp;size=0</code>. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <returns>The response from the DescribeDomains service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeDomains(Amazon.CloudSearch.Model.DescribeDomainsRequest)"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&amp;q.parser=structured&amp;size=0</code>. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomains service method.</param> <returns>The response from the DescribeDomains service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeDomainsAsync(Amazon.CloudSearch.Model.DescribeDomainsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDomains operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomains operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeExpressions(Amazon.CloudSearch.Model.DescribeExpressionsRequest)"> <summary> Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExpressions service method.</param> <returns>The response from the DescribeExpressions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeExpressionsAsync(Amazon.CloudSearch.Model.DescribeExpressionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeExpressions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExpressions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeIndexFields(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest)"> <summary> Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Domain Information</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIndexFields service method.</param> <returns>The response from the DescribeIndexFields service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeIndexFieldsAsync(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeIndexFields operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIndexFields operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeScalingParameters(Amazon.CloudSearch.Model.DescribeScalingParametersRequest)"> <summary> Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingParameters service method.</param> <returns>The response from the DescribeScalingParameters service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeScalingParametersAsync(Amazon.CloudSearch.Model.DescribeScalingParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeScalingParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeServiceAccessPolicies(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest)"> <summary> Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceAccessPolicies service method.</param> <returns>The response from the DescribeServiceAccessPolicies service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeServiceAccessPoliciesAsync(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceAccessPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeSuggesters(Amazon.CloudSearch.Model.DescribeSuggestersRequest)"> <summary> Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSuggesters service method.</param> <returns>The response from the DescribeSuggesters service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeSuggestersAsync(Amazon.CloudSearch.Model.DescribeSuggestersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSuggesters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSuggesters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.IndexDocuments(Amazon.CloudSearch.Model.IndexDocumentsRequest)"> <summary> Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose <a>OptionStatus</a> is <code>RequiresIndexDocuments</code>. </summary> <param name="request">Container for the necessary parameters to execute the IndexDocuments service method.</param> <returns>The response from the IndexDocuments service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.IndexDocumentsAsync(Amazon.CloudSearch.Model.IndexDocumentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the IndexDocuments operation. </summary> <param name="request">Container for the necessary parameters to execute the IndexDocuments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.ListDomainNames"> <summary> Lists all search domains owned by an account. </summary> <returns>The response from the ListDomainNames service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.ListDomainNames(Amazon.CloudSearch.Model.ListDomainNamesRequest)"> <summary> Lists all search domains owned by an account. </summary> <param name="request">Container for the necessary parameters to execute the ListDomainNames service method.</param> <returns>The response from the ListDomainNames service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.ListDomainNamesAsync(Amazon.CloudSearch.Model.ListDomainNamesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDomainNames operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDomainNames operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.UpdateAvailabilityOptions(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest)"> <summary> Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAvailabilityOptions service method.</param> <returns>The response from the UpdateAvailabilityOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.DisabledOperationException"> The request was rejected because it attempted an operation which is not enabled. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.UpdateAvailabilityOptionsAsync(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAvailabilityOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAvailabilityOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.UpdateScalingParameters(Amazon.CloudSearch.Model.UpdateScalingParametersRequest)"> <summary> Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateScalingParameters service method.</param> <returns>The response from the UpdateScalingParameters service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.UpdateScalingParametersAsync(Amazon.CloudSearch.Model.UpdateScalingParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateScalingParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateScalingParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.UpdateServiceAccessPolicies(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest)"> <summary> Configures the access rules that control access to the domain's document and search endpoints. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank"> Configuring Access for an Amazon CloudSearch Domain</a>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServiceAccessPolicies service method.</param> <returns>The response from the UpdateServiceAccessPolicies service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.UpdateServiceAccessPoliciesAsync(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateServiceAccessPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServiceAccessPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient"> <summary> Implementation for accessing CloudSearch Amazon CloudSearch Configuration Service <para> You use the configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action. </para> <para> The endpoint for configuration service requests is region-specific: cloudsearch.<i>region</i>.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region">Regions and Endpoints</a>. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch"> <summary> Interface for accessing CloudSearch Amazon CloudSearch Configuration Service <para> You use the configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action. </para> <para> The endpoint for configuration service requests is region-specific: cloudsearch.<i>region</i>.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region">Regions and Endpoints</a>. </para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.CreateDomain(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest)"> <summary> Creates a new search domain. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain service method.</param> <returns>The response from the CreateDomain service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.CreateDomainAsync(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DefineIndexField(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest)"> <summary> Configures an <code>IndexField</code> for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields. </summary> <param name="request">Container for the necessary parameters to execute the DefineIndexField service method.</param> <returns>The response from the DefineIndexField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DefineIndexFieldAsync(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DefineIndexField operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineIndexField operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DefineRankExpression(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest)"> <summary> Configures a <code>RankExpression</code> for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions. </summary> <param name="request">Container for the necessary parameters to execute the DefineRankExpression service method.</param> <returns>The response from the DefineRankExpression service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DefineRankExpressionAsync(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DefineRankExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineRankExpression operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DeleteDomain(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest)"> <summary> Permanently deletes a search domain and all of its data. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain service method.</param> <returns>The response from the DeleteDomain service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DeleteDomainAsync(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DeleteIndexField(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest)"> <summary> Removes an <code>IndexField</code> from the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIndexField service method.</param> <returns>The response from the DeleteIndexField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DeleteIndexFieldAsync(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteIndexField operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIndexField operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DeleteRankExpression(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest)"> <summary> Removes a <code>RankExpression</code> from the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRankExpression service method.</param> <returns>The response from the DeleteRankExpression service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DeleteRankExpressionAsync(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRankExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRankExpression operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeAvailabilityOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeAvailabilityOptionsRequest)"> <summary> Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityOptions service method.</param> <returns>The response from the DescribeAvailabilityOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.DisabledOperationException"> The request was rejected because it attempted an operation which is not enabled. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeAvailabilityOptionsAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeAvailabilityOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAvailabilityOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest)"> <summary> Gets the default search field configured for the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDefaultSearchField service method.</param> <returns>The response from the DescribeDefaultSearchField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeDefaultSearchFieldAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDefaultSearchField operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDefaultSearchField operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeDomains"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. </summary> <returns>The response from the DescribeDomains service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeDomains(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest)"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomains service method.</param> <returns>The response from the DescribeDomains service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeDomainsAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDomains operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomains operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeIndexFields(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest)"> <summary> Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIndexFields service method.</param> <returns>The response from the DescribeIndexFields service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeIndexFieldsAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeIndexFields operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIndexFields operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeRankExpressions(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest)"> <summary> Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRankExpressions service method.</param> <returns>The response from the DescribeRankExpressions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeRankExpressionsAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeRankExpressions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRankExpressions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest)"> <summary> Gets information about the resource-based policies that control access to the domain's document and search services. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceAccessPolicies service method.</param> <returns>The response from the DescribeServiceAccessPolicies service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeServiceAccessPoliciesAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceAccessPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest)"> <summary> Gets the stemming dictionary configured for the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStemmingOptions service method.</param> <returns>The response from the DescribeStemmingOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeStemmingOptionsAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStemmingOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStemmingOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest)"> <summary> Gets the stopwords configured for the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStopwordOptions service method.</param> <returns>The response from the DescribeStopwordOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeStopwordOptionsAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStopwordOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStopwordOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest)"> <summary> Gets the synonym dictionary configured for the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSynonymOptions service method.</param> <returns>The response from the DescribeSynonymOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeSynonymOptionsAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSynonymOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSynonymOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.IndexDocuments(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest)"> <summary> Tells the search domain to start indexing its documents using the latest text processing options and <code>IndexFields</code>. This operation must be invoked to make options whose <a>OptionStatus</a> has <code>OptionState</code> of <code>RequiresIndexDocuments</code> visible in search results. </summary> <param name="request">Container for the necessary parameters to execute the IndexDocuments service method.</param> <returns>The response from the IndexDocuments service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.IndexDocumentsAsync(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the IndexDocuments operation. </summary> <param name="request">Container for the necessary parameters to execute the IndexDocuments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateAvailabilityOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateAvailabilityOptionsRequest)"> <summary> Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAvailabilityOptions service method.</param> <returns>The response from the UpdateAvailabilityOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.DisabledOperationException"> The request was rejected because it attempted an operation which is not enabled. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateAvailabilityOptionsAsync(Amazon.CloudSearch_2011_02_01.Model.UpdateAvailabilityOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAvailabilityOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAvailabilityOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest)"> <summary> Configures the default search field for the search domain. The default search field is the text field that is searched when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDefaultSearchField service method.</param> <returns>The response from the UpdateDefaultSearchField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateDefaultSearchFieldAsync(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDefaultSearchField operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDefaultSearchField operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest)"> <summary> Configures the policies that control access to the domain's document and search services. The maximum size of an access policy document is 100 KB. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServiceAccessPolicies service method.</param> <returns>The response from the UpdateServiceAccessPolicies service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateServiceAccessPoliciesAsync(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateServiceAccessPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServiceAccessPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest)"> <summary> Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500 KB. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStemmingOptions service method.</param> <returns>The response from the UpdateStemmingOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateStemmingOptionsAsync(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateStemmingOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStemmingOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest)"> <summary> Configures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10 KB. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStopwordOptions service method.</param> <returns>The response from the UpdateStopwordOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateStopwordOptionsAsync(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateStopwordOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStopwordOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest)"> <summary> Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100 KB. </summary> <param name="request">Container for the necessary parameters to execute the UpdateSynonymOptions service method.</param> <returns>The response from the UpdateSynonymOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateSynonymOptionsAsync(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateSynonymOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateSynonymOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor"> <summary> Constructs AmazonCloudSearchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudSearchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(Amazon.CloudSearch_2011_02_01.AmazonCloudSearchConfig)"> <summary> Constructs AmazonCloudSearchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudSearchClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudSearchClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudSearchClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudSearch_2011_02_01.AmazonCloudSearchConfig)"> <summary> Constructs AmazonCloudSearchClient with AWS Credentials and an AmazonCloudSearchClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudSearchClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(System.String,System.String,Amazon.CloudSearch_2011_02_01.AmazonCloudSearchConfig)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudSearchClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudSearchClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(System.String,System.String,System.String,Amazon.CloudSearch_2011_02_01.AmazonCloudSearchConfig)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudSearchClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudSearchClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.CreateDomain(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest)"> <summary> Creates a new search domain. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain service method.</param> <returns>The response from the CreateDomain service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.CreateDomainAsync(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DefineIndexField(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest)"> <summary> Configures an <code>IndexField</code> for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields. </summary> <param name="request">Container for the necessary parameters to execute the DefineIndexField service method.</param> <returns>The response from the DefineIndexField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DefineIndexFieldAsync(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DefineIndexField operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineIndexField operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DefineRankExpression(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest)"> <summary> Configures a <code>RankExpression</code> for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions. </summary> <param name="request">Container for the necessary parameters to execute the DefineRankExpression service method.</param> <returns>The response from the DefineRankExpression service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DefineRankExpressionAsync(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DefineRankExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineRankExpression operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DeleteDomain(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest)"> <summary> Permanently deletes a search domain and all of its data. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain service method.</param> <returns>The response from the DeleteDomain service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DeleteDomainAsync(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DeleteIndexField(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest)"> <summary> Removes an <code>IndexField</code> from the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIndexField service method.</param> <returns>The response from the DeleteIndexField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DeleteIndexFieldAsync(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteIndexField operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIndexField operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DeleteRankExpression(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest)"> <summary> Removes a <code>RankExpression</code> from the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRankExpression service method.</param> <returns>The response from the DeleteRankExpression service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DeleteRankExpressionAsync(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRankExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRankExpression operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeAvailabilityOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeAvailabilityOptionsRequest)"> <summary> Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityOptions service method.</param> <returns>The response from the DescribeAvailabilityOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.DisabledOperationException"> The request was rejected because it attempted an operation which is not enabled. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeAvailabilityOptionsAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeAvailabilityOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAvailabilityOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest)"> <summary> Gets the default search field configured for the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDefaultSearchField service method.</param> <returns>The response from the DescribeDefaultSearchField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeDefaultSearchFieldAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDefaultSearchField operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDefaultSearchField operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeDomains"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. </summary> <returns>The response from the DescribeDomains service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeDomains(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest)"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomains service method.</param> <returns>The response from the DescribeDomains service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeDomainsAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDomains operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomains operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeIndexFields(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest)"> <summary> Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIndexFields service method.</param> <returns>The response from the DescribeIndexFields service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeIndexFieldsAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeIndexFields operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIndexFields operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeRankExpressions(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest)"> <summary> Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRankExpressions service method.</param> <returns>The response from the DescribeRankExpressions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeRankExpressionsAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeRankExpressions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRankExpressions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest)"> <summary> Gets information about the resource-based policies that control access to the domain's document and search services. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceAccessPolicies service method.</param> <returns>The response from the DescribeServiceAccessPolicies service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeServiceAccessPoliciesAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceAccessPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest)"> <summary> Gets the stemming dictionary configured for the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStemmingOptions service method.</param> <returns>The response from the DescribeStemmingOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeStemmingOptionsAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStemmingOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStemmingOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest)"> <summary> Gets the stopwords configured for the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStopwordOptions service method.</param> <returns>The response from the DescribeStopwordOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeStopwordOptionsAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStopwordOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStopwordOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest)"> <summary> Gets the synonym dictionary configured for the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSynonymOptions service method.</param> <returns>The response from the DescribeSynonymOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeSynonymOptionsAsync(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSynonymOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSynonymOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.IndexDocuments(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest)"> <summary> Tells the search domain to start indexing its documents using the latest text processing options and <code>IndexFields</code>. This operation must be invoked to make options whose <a>OptionStatus</a> has <code>OptionState</code> of <code>RequiresIndexDocuments</code> visible in search results. </summary> <param name="request">Container for the necessary parameters to execute the IndexDocuments service method.</param> <returns>The response from the IndexDocuments service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.IndexDocumentsAsync(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the IndexDocuments operation. </summary> <param name="request">Container for the necessary parameters to execute the IndexDocuments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateAvailabilityOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateAvailabilityOptionsRequest)"> <summary> Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAvailabilityOptions service method.</param> <returns>The response from the UpdateAvailabilityOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.DisabledOperationException"> The request was rejected because it attempted an operation which is not enabled. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateAvailabilityOptionsAsync(Amazon.CloudSearch_2011_02_01.Model.UpdateAvailabilityOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAvailabilityOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAvailabilityOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest)"> <summary> Configures the default search field for the search domain. The default search field is the text field that is searched when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDefaultSearchField service method.</param> <returns>The response from the UpdateDefaultSearchField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateDefaultSearchFieldAsync(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDefaultSearchField operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDefaultSearchField operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest)"> <summary> Configures the policies that control access to the domain's document and search services. The maximum size of an access policy document is 100 KB. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServiceAccessPolicies service method.</param> <returns>The response from the UpdateServiceAccessPolicies service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateServiceAccessPoliciesAsync(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateServiceAccessPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServiceAccessPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest)"> <summary> Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500 KB. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStemmingOptions service method.</param> <returns>The response from the UpdateStemmingOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateStemmingOptionsAsync(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateStemmingOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStemmingOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest)"> <summary> Configures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10 KB. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStopwordOptions service method.</param> <returns>The response from the UpdateStopwordOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateStopwordOptionsAsync(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateStopwordOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStopwordOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest)"> <summary> Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100 KB. </summary> <param name="request">Container for the necessary parameters to execute the UpdateSynonymOptions service method.</param> <returns>The response from the UpdateSynonymOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateSynonymOptionsAsync(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateSynonymOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateSynonymOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.CloudTrail.AmazonCloudTrailClient"> <summary> Implementation for accessing CloudTrail AWS CloudTrail <para> This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail. </para> <para> CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service. </para> <note> As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services page</a>. </note> <para> See the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files. </para> </summary> </member> <member name="T:Amazon.CloudTrail.IAmazonCloudTrail"> <summary> Interface for accessing CloudTrail AWS CloudTrail <para> This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail. </para> <para> CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service. </para> <note> As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services page</a>. </note> <para> See the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files. </para> </summary> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.AddTags(Amazon.CloudTrail.Model.AddTagsRequest)"> <summary> Adds one or more tags to a trail, up to a limit of 10. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region). </summary> <param name="request">Container for the necessary parameters to execute the AddTags service method.</param> <returns>The response from the AddTags service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudTrailARNInvalidException"> This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTagParameterException"> This exception is thrown when the key or value specified for the tag does not match the regular expression <code>^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceNotFoundException"> This exception is thrown when the specified resource is not found. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceTypeNotSupportedException"> This exception is thrown when the specified resource type is not supported by CloudTrail. </exception> <exception cref="T:Amazon.CloudTrail.Model.TagsLimitExceededException"> The number of tags per trail has exceeded the permitted amount. Currently, the limit is 10. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.AddTagsAsync(Amazon.CloudTrail.Model.AddTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTags operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.CreateTrail(Amazon.CloudTrail.Model.CreateTrailRequest)"> <summary> Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrail service method.</param> <returns>The response from the CreateTrail service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudWatchLogsDeliveryUnavailableException"> Cannot set a CloudWatch Logs delivery for this region. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientEncryptionPolicyException"> This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientS3BucketPolicyException"> This exception is thrown when the policy on the S3 bucket is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientSnsTopicPolicyException"> This exception is thrown when the policy on the SNS topic is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsLogGroupArnException"> This exception is thrown when the provided CloudWatch log group is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsRoleArnException"> This exception is thrown when the provided role is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidKmsKeyIdException"> This exception is thrown when the KMS key ARN is invalid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidParameterCombinationException"> This exception is thrown when the combination of parameters provided is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3BucketNameException"> This exception is thrown when the provided S3 bucket name is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3PrefixException"> This exception is thrown when the provided S3 prefix is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidSnsTopicNameException"> This exception is thrown when the provided SNS topic name is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.KmsKeyDisabledException"> This exception is thrown when the KMS key is disabled. </exception> <exception cref="T:Amazon.CloudTrail.Model.KmsKeyNotFoundException"> This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region. </exception> <exception cref="T:Amazon.CloudTrail.Model.MaximumNumberOfTrailsExceededException"> This exception is thrown when the maximum number of trails is reached. </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.S3BucketDoesNotExistException"> This exception is thrown when the specified S3 bucket does not exist. </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailAlreadyExistsException"> This exception is thrown when the specified trail already exists. </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotProvidedException"> This exception is deprecated. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.CreateTrailAsync(Amazon.CloudTrail.Model.CreateTrailRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTrail operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrail operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.DeleteTrail(Amazon.CloudTrail.Model.DeleteTrailRequest)"> <summary> Deletes a trail. This operation must be called from the region in which the trail was created. <code>DeleteTrail</code> cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrail service method.</param> <returns>The response from the DeleteTrail service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.DeleteTrailAsync(Amazon.CloudTrail.Model.DeleteTrailRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTrail operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrail operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.DescribeTrails"> <summary> Retrieves settings for the trail associated with the current region for your account. </summary> <returns>The response from the DescribeTrails service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.DescribeTrails(Amazon.CloudTrail.Model.DescribeTrailsRequest)"> <summary> Retrieves settings for the trail associated with the current region for your account. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrails service method.</param> <returns>The response from the DescribeTrails service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.DescribeTrailsAsync(Amazon.CloudTrail.Model.DescribeTrailsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTrails operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrails operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.GetTrailStatus(Amazon.CloudTrail.Model.GetTrailStatusRequest)"> <summary> Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region. </summary> <param name="request">Container for the necessary parameters to execute the GetTrailStatus service method.</param> <returns>The response from the GetTrailStatus service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.GetTrailStatusAsync(Amazon.CloudTrail.Model.GetTrailStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetTrailStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTrailStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.ListPublicKeys(Amazon.CloudTrail.Model.ListPublicKeysRequest)"> <summary> Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key. <note>CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.</note> </summary> <param name="request">Container for the necessary parameters to execute the ListPublicKeys service method.</param> <returns>The response from the ListPublicKeys service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidTimeRangeException"> Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTokenException"> Reserved for future use. </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.ListPublicKeysAsync(Amazon.CloudTrail.Model.ListPublicKeysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListPublicKeys operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPublicKeys operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.ListTags(Amazon.CloudTrail.Model.ListTagsRequest)"> <summary> Lists the tags for the specified trail or trails in the current region. <para> Lists the tags for the trail in the current region. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListTags service method.</param> <returns>The response from the ListTags service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudTrailARNInvalidException"> This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTokenException"> Reserved for future use. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceNotFoundException"> This exception is thrown when the specified resource is not found. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceTypeNotSupportedException"> This exception is thrown when the specified resource type is not supported by CloudTrail. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.ListTagsAsync(Amazon.CloudTrail.Model.ListTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTags operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.LookupEvents(Amazon.CloudTrail.Model.LookupEventsRequest)"> <summary> Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports five different attributes: time range (defined by a start time and end time), user name, event name, resource type, and resource name. All attributes are optional. The maximum number of attributes that can be specified in any one lookup request are time range and one other attribute. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results. <important>The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs. </important> <important>Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.</important> </summary> <param name="request">Container for the necessary parameters to execute the LookupEvents service method.</param> <returns>The response from the LookupEvents service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidLookupAttributesException"> Occurs when an invalid lookup attribute is specified. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidMaxResultsException"> This exception is thrown if the limit specified is invalid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidNextTokenException"> Invalid token or token that was previously used in a request with different parameters. This exception is thrown if the token is invalid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTimeRangeException"> Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.LookupEventsAsync(Amazon.CloudTrail.Model.LookupEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the LookupEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the LookupEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.RemoveTags(Amazon.CloudTrail.Model.RemoveTagsRequest)"> <summary> Removes the specified tags from a trail. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags service method.</param> <returns>The response from the RemoveTags service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudTrailARNInvalidException"> This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTagParameterException"> This exception is thrown when the key or value specified for the tag does not match the regular expression <code>^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceNotFoundException"> This exception is thrown when the specified resource is not found. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceTypeNotSupportedException"> This exception is thrown when the specified resource type is not supported by CloudTrail. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.RemoveTagsAsync(Amazon.CloudTrail.Model.RemoveTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTags operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.StartLogging(Amazon.CloudTrail.Model.StartLoggingRequest)"> <summary> Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. </summary> <param name="request">Container for the necessary parameters to execute the StartLogging service method.</param> <returns>The response from the StartLogging service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.StartLoggingAsync(Amazon.CloudTrail.Model.StartLoggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartLogging operation. </summary> <param name="request">Container for the necessary parameters to execute the StartLogging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.StopLogging(Amazon.CloudTrail.Model.StopLoggingRequest)"> <summary> Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an <code>InvalidHomeRegionException</code> will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions. </summary> <param name="request">Container for the necessary parameters to execute the StopLogging service method.</param> <returns>The response from the StopLogging service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.StopLoggingAsync(Amazon.CloudTrail.Model.StopLoggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StopLogging operation. </summary> <param name="request">Container for the necessary parameters to execute the StopLogging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.UpdateTrail(Amazon.CloudTrail.Model.UpdateTrailRequest)"> <summary> Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. <code>UpdateTrail</code> must be called from the region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> is thrown. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTrail service method.</param> <returns>The response from the UpdateTrail service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudWatchLogsDeliveryUnavailableException"> Cannot set a CloudWatch Logs delivery for this region. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientEncryptionPolicyException"> This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientS3BucketPolicyException"> This exception is thrown when the policy on the S3 bucket is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientSnsTopicPolicyException"> This exception is thrown when the policy on the SNS topic is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsLogGroupArnException"> This exception is thrown when the provided CloudWatch log group is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsRoleArnException"> This exception is thrown when the provided role is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidKmsKeyIdException"> This exception is thrown when the KMS key ARN is invalid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidParameterCombinationException"> This exception is thrown when the combination of parameters provided is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3BucketNameException"> This exception is thrown when the provided S3 bucket name is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3PrefixException"> This exception is thrown when the provided S3 prefix is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidSnsTopicNameException"> This exception is thrown when the provided SNS topic name is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.KmsKeyDisabledException"> This exception is thrown when the KMS key is disabled. </exception> <exception cref="T:Amazon.CloudTrail.Model.KmsKeyNotFoundException"> This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region. </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.S3BucketDoesNotExistException"> This exception is thrown when the specified S3 bucket does not exist. </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotProvidedException"> This exception is deprecated. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.UpdateTrailAsync(Amazon.CloudTrail.Model.UpdateTrailRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateTrail operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTrail operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor"> <summary> Constructs AmazonCloudTrailClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudTrailClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(Amazon.CloudTrail.AmazonCloudTrailConfig)"> <summary> Constructs AmazonCloudTrailClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudTrailClient Configuration Object</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudTrailClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudTrailClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudTrail.AmazonCloudTrailConfig)"> <summary> Constructs AmazonCloudTrailClient with AWS Credentials and an AmazonCloudTrailClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudTrailClient Configuration Object</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(System.String,System.String,Amazon.CloudTrail.AmazonCloudTrailConfig)"> <summary> Constructs AmazonCloudTrailClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudTrailClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudTrailClient Configuration Object</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(System.String,System.String,System.String,Amazon.CloudTrail.AmazonCloudTrailConfig)"> <summary> Constructs AmazonCloudTrailClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudTrailClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudTrailClient Configuration Object</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.AddTags(Amazon.CloudTrail.Model.AddTagsRequest)"> <summary> Adds one or more tags to a trail, up to a limit of 10. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region). </summary> <param name="request">Container for the necessary parameters to execute the AddTags service method.</param> <returns>The response from the AddTags service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudTrailARNInvalidException"> This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTagParameterException"> This exception is thrown when the key or value specified for the tag does not match the regular expression <code>^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceNotFoundException"> This exception is thrown when the specified resource is not found. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceTypeNotSupportedException"> This exception is thrown when the specified resource type is not supported by CloudTrail. </exception> <exception cref="T:Amazon.CloudTrail.Model.TagsLimitExceededException"> The number of tags per trail has exceeded the permitted amount. Currently, the limit is 10. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.AddTagsAsync(Amazon.CloudTrail.Model.AddTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTags operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.CreateTrail(Amazon.CloudTrail.Model.CreateTrailRequest)"> <summary> Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrail service method.</param> <returns>The response from the CreateTrail service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudWatchLogsDeliveryUnavailableException"> Cannot set a CloudWatch Logs delivery for this region. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientEncryptionPolicyException"> This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientS3BucketPolicyException"> This exception is thrown when the policy on the S3 bucket is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientSnsTopicPolicyException"> This exception is thrown when the policy on the SNS topic is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsLogGroupArnException"> This exception is thrown when the provided CloudWatch log group is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsRoleArnException"> This exception is thrown when the provided role is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidKmsKeyIdException"> This exception is thrown when the KMS key ARN is invalid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidParameterCombinationException"> This exception is thrown when the combination of parameters provided is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3BucketNameException"> This exception is thrown when the provided S3 bucket name is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3PrefixException"> This exception is thrown when the provided S3 prefix is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidSnsTopicNameException"> This exception is thrown when the provided SNS topic name is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.KmsKeyDisabledException"> This exception is thrown when the KMS key is disabled. </exception> <exception cref="T:Amazon.CloudTrail.Model.KmsKeyNotFoundException"> This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region. </exception> <exception cref="T:Amazon.CloudTrail.Model.MaximumNumberOfTrailsExceededException"> This exception is thrown when the maximum number of trails is reached. </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.S3BucketDoesNotExistException"> This exception is thrown when the specified S3 bucket does not exist. </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailAlreadyExistsException"> This exception is thrown when the specified trail already exists. </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotProvidedException"> This exception is deprecated. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.CreateTrailAsync(Amazon.CloudTrail.Model.CreateTrailRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTrail operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrail operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.DeleteTrail(Amazon.CloudTrail.Model.DeleteTrailRequest)"> <summary> Deletes a trail. This operation must be called from the region in which the trail was created. <code>DeleteTrail</code> cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrail service method.</param> <returns>The response from the DeleteTrail service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.DeleteTrailAsync(Amazon.CloudTrail.Model.DeleteTrailRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTrail operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrail operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.DescribeTrails"> <summary> Retrieves settings for the trail associated with the current region for your account. </summary> <returns>The response from the DescribeTrails service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.DescribeTrails(Amazon.CloudTrail.Model.DescribeTrailsRequest)"> <summary> Retrieves settings for the trail associated with the current region for your account. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrails service method.</param> <returns>The response from the DescribeTrails service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.DescribeTrailsAsync(Amazon.CloudTrail.Model.DescribeTrailsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTrails operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrails operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.GetTrailStatus(Amazon.CloudTrail.Model.GetTrailStatusRequest)"> <summary> Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region. </summary> <param name="request">Container for the necessary parameters to execute the GetTrailStatus service method.</param> <returns>The response from the GetTrailStatus service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.GetTrailStatusAsync(Amazon.CloudTrail.Model.GetTrailStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetTrailStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTrailStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.ListPublicKeys(Amazon.CloudTrail.Model.ListPublicKeysRequest)"> <summary> Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key. <note>CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.</note> </summary> <param name="request">Container for the necessary parameters to execute the ListPublicKeys service method.</param> <returns>The response from the ListPublicKeys service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidTimeRangeException"> Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTokenException"> Reserved for future use. </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.ListPublicKeysAsync(Amazon.CloudTrail.Model.ListPublicKeysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListPublicKeys operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPublicKeys operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.ListTags(Amazon.CloudTrail.Model.ListTagsRequest)"> <summary> Lists the tags for the specified trail or trails in the current region. <para> Lists the tags for the trail in the current region. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListTags service method.</param> <returns>The response from the ListTags service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudTrailARNInvalidException"> This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTokenException"> Reserved for future use. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceNotFoundException"> This exception is thrown when the specified resource is not found. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceTypeNotSupportedException"> This exception is thrown when the specified resource type is not supported by CloudTrail. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.ListTagsAsync(Amazon.CloudTrail.Model.ListTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTags operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.LookupEvents(Amazon.CloudTrail.Model.LookupEventsRequest)"> <summary> Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports five different attributes: time range (defined by a start time and end time), user name, event name, resource type, and resource name. All attributes are optional. The maximum number of attributes that can be specified in any one lookup request are time range and one other attribute. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results. <important>The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs. </important> <important>Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.</important> </summary> <param name="request">Container for the necessary parameters to execute the LookupEvents service method.</param> <returns>The response from the LookupEvents service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidLookupAttributesException"> Occurs when an invalid lookup attribute is specified. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidMaxResultsException"> This exception is thrown if the limit specified is invalid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidNextTokenException"> Invalid token or token that was previously used in a request with different parameters. This exception is thrown if the token is invalid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTimeRangeException"> Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.LookupEventsAsync(Amazon.CloudTrail.Model.LookupEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the LookupEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the LookupEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.RemoveTags(Amazon.CloudTrail.Model.RemoveTagsRequest)"> <summary> Removes the specified tags from a trail. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags service method.</param> <returns>The response from the RemoveTags service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudTrailARNInvalidException"> This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTagParameterException"> This exception is thrown when the key or value specified for the tag does not match the regular expression <code>^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceNotFoundException"> This exception is thrown when the specified resource is not found. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceTypeNotSupportedException"> This exception is thrown when the specified resource type is not supported by CloudTrail. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.RemoveTagsAsync(Amazon.CloudTrail.Model.RemoveTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTags operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.StartLogging(Amazon.CloudTrail.Model.StartLoggingRequest)"> <summary> Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. </summary> <param name="request">Container for the necessary parameters to execute the StartLogging service method.</param> <returns>The response from the StartLogging service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.StartLoggingAsync(Amazon.CloudTrail.Model.StartLoggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartLogging operation. </summary> <param name="request">Container for the necessary parameters to execute the StartLogging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.StopLogging(Amazon.CloudTrail.Model.StopLoggingRequest)"> <summary> Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an <code>InvalidHomeRegionException</code> will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions. </summary> <param name="request">Container for the necessary parameters to execute the StopLogging service method.</param> <returns>The response from the StopLogging service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.StopLoggingAsync(Amazon.CloudTrail.Model.StopLoggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StopLogging operation. </summary> <param name="request">Container for the necessary parameters to execute the StopLogging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.UpdateTrail(Amazon.CloudTrail.Model.UpdateTrailRequest)"> <summary> Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. <code>UpdateTrail</code> must be called from the region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> is thrown. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTrail service method.</param> <returns>The response from the UpdateTrail service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudWatchLogsDeliveryUnavailableException"> Cannot set a CloudWatch Logs delivery for this region. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientEncryptionPolicyException"> This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientS3BucketPolicyException"> This exception is thrown when the policy on the S3 bucket is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientSnsTopicPolicyException"> This exception is thrown when the policy on the SNS topic is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsLogGroupArnException"> This exception is thrown when the provided CloudWatch log group is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsRoleArnException"> This exception is thrown when the provided role is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidKmsKeyIdException"> This exception is thrown when the KMS key ARN is invalid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidParameterCombinationException"> This exception is thrown when the combination of parameters provided is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3BucketNameException"> This exception is thrown when the provided S3 bucket name is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3PrefixException"> This exception is thrown when the provided S3 prefix is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidSnsTopicNameException"> This exception is thrown when the provided SNS topic name is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.KmsKeyDisabledException"> This exception is thrown when the KMS key is disabled. </exception> <exception cref="T:Amazon.CloudTrail.Model.KmsKeyNotFoundException"> This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region. </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.S3BucketDoesNotExistException"> This exception is thrown when the specified S3 bucket does not exist. </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotProvidedException"> This exception is deprecated. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.UpdateTrailAsync(Amazon.CloudTrail.Model.UpdateTrailRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateTrail operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTrail operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.ConfigService.AmazonConfigServiceClient"> <summary> Implementation for accessing ConfigService AWS Config <para> AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an Elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by AWS Config, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported AWS Resources</a>. </para> <para> You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config </para> <para> This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config. </para> <para> The AWS Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. </para> <para> For detailed information about AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html">What Is AWS Config?</a> in the <i>AWS Config Developer Guide</i>. </para> </summary> </member> <member name="T:Amazon.ConfigService.IAmazonConfigService"> <summary> Interface for accessing ConfigService AWS Config <para> AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an Elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by AWS Config, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported AWS Resources</a>. </para> <para> You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config </para> <para> This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config. </para> <para> The AWS Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. </para> <para> For detailed information about AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html">What Is AWS Config?</a> in the <i>AWS Config Developer Guide</i>. </para> </summary> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DeleteConfigRule(Amazon.ConfigService.Model.DeleteConfigRuleRequest)"> <summary> Deletes the specified AWS Config rule and all of its evaluation results. <para> AWS Config sets the state of a rule to <code>DELETING</code> until the deletion is complete. You cannot update a rule while it is in this state. If you make a <code>PutConfigRule</code> request for the rule, you will receive a <code>ResourceInUseException</code>. </para> <para> You can check the state of a rule by using the <code>DescribeConfigRules</code> request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteConfigRule service method.</param> <returns>The response from the DeleteConfigRule service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.ResourceInUseException"> The rule is currently being deleted. Wait for a while and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DeleteConfigRuleAsync(Amazon.ConfigService.Model.DeleteConfigRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteConfigRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DeleteDeliveryChannel(System.String)"> <summary> Deletes the specified delivery channel. <para> The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the <a>StopConfigurationRecorder</a> action. </para> </summary> <param name="deliveryChannelName">The name of the delivery channel to delete.</param> <returns>The response from the DeleteDeliveryChannel service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.LastDeliveryChannelDeleteFailedException"> You cannot delete the delivery channel you specified because the configuration recorder is running. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DeleteDeliveryChannel(Amazon.ConfigService.Model.DeleteDeliveryChannelRequest)"> <summary> Deletes the specified delivery channel. <para> The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the <a>StopConfigurationRecorder</a> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeliveryChannel service method.</param> <returns>The response from the DeleteDeliveryChannel service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.LastDeliveryChannelDeleteFailedException"> You cannot delete the delivery channel you specified because the configuration recorder is running. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DeleteDeliveryChannelAsync(Amazon.ConfigService.Model.DeleteDeliveryChannelRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDeliveryChannel operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeliveryChannel operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DeliverConfigSnapshot(System.String)"> <summary> Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified. <ul> <li>Notification of starting the delivery.</li> <li>Notification of delivery completed, if the delivery was successfully completed.</li> <li>Notification of delivery failure, if the delivery failed to complete.</li> </ul> </summary> <param name="deliveryChannelName">The name of the delivery channel through which the snapshot is delivered.</param> <returns>The response from the DeliverConfigSnapshot service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.NoRunningConfigurationRecorderException"> There is no configuration recorder running. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DeliverConfigSnapshot(Amazon.ConfigService.Model.DeliverConfigSnapshotRequest)"> <summary> Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified. <ul> <li>Notification of starting the delivery.</li> <li>Notification of delivery completed, if the delivery was successfully completed.</li> <li>Notification of delivery failure, if the delivery failed to complete.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DeliverConfigSnapshot service method.</param> <returns>The response from the DeliverConfigSnapshot service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.NoRunningConfigurationRecorderException"> There is no configuration recorder running. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DeliverConfigSnapshotAsync(Amazon.ConfigService.Model.DeliverConfigSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeliverConfigSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeliverConfigSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeComplianceByConfigRule(Amazon.ConfigService.Model.DescribeComplianceByConfigRuleRequest)"> <summary> Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule. <para> A rule is compliant if all of the evaluated resources comply with it, and it is noncompliant if any of these resources do not comply. </para> <para> If AWS Config has no current evaluation results for the rule, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions: <ul> <li>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</li> <li>The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the <code>config:PutEvaluations</code> permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</li> <li>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</li></ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeComplianceByConfigRule service method.</param> <returns>The response from the DescribeComplianceByConfigRule service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeComplianceByConfigRuleAsync(Amazon.ConfigService.Model.DescribeComplianceByConfigRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeComplianceByConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeComplianceByConfigRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeComplianceByResource(Amazon.ConfigService.Model.DescribeComplianceByResourceRequest)"> <summary> Indicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with. <para> A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules. </para> <para> If AWS Config has no current evaluation results for the resource, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions about the rules that evaluate the resource: <ul> <li>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</li> <li>The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the <code>config:PutEvaluations</code> permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</li> <li>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</li></ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeComplianceByResource service method.</param> <returns>The response from the DescribeComplianceByResource service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidNextTokenException"> The specified next token is invalid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeComplianceByResourceAsync(Amazon.ConfigService.Model.DescribeComplianceByResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeComplianceByResource operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeComplianceByResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeConfigRuleEvaluationStatus(Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusRequest)"> <summary> Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigRuleEvaluationStatus service method.</param> <returns>The response from the DescribeConfigRuleEvaluationStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeConfigRuleEvaluationStatusAsync(Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConfigRuleEvaluationStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigRuleEvaluationStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeConfigRules(Amazon.ConfigService.Model.DescribeConfigRulesRequest)"> <summary> Returns details about your AWS Config rules. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigRules service method.</param> <returns>The response from the DescribeConfigRules service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeConfigRulesAsync(Amazon.ConfigService.Model.DescribeConfigRulesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConfigRules operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigRules operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeConfigurationRecorders"> <summary> Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account. <note> <para> Currently, you can specify only one configuration recorder per account. </para> </note> </summary> <returns>The response from the DescribeConfigurationRecorders service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeConfigurationRecorders(Amazon.ConfigService.Model.DescribeConfigurationRecordersRequest)"> <summary> Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account. <note> <para> Currently, you can specify only one configuration recorder per account. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationRecorders service method.</param> <returns>The response from the DescribeConfigurationRecorders service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeConfigurationRecordersAsync(Amazon.ConfigService.Model.DescribeConfigurationRecordersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConfigurationRecorders operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationRecorders operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeConfigurationRecorderStatus"> <summary> Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account. <note>Currently, you can specify only one configuration recorder per account.</note> </summary> <returns>The response from the DescribeConfigurationRecorderStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeConfigurationRecorderStatus(Amazon.ConfigService.Model.DescribeConfigurationRecorderStatusRequest)"> <summary> Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account. <note>Currently, you can specify only one configuration recorder per account.</note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationRecorderStatus service method.</param> <returns>The response from the DescribeConfigurationRecorderStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeConfigurationRecorderStatusAsync(Amazon.ConfigService.Model.DescribeConfigurationRecorderStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConfigurationRecorderStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationRecorderStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeDeliveryChannels"> <summary> Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account. <note> <para> Currently, you can specify only one delivery channel per account. </para> </note> </summary> <returns>The response from the DescribeDeliveryChannels service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeDeliveryChannels(Amazon.ConfigService.Model.DescribeDeliveryChannelsRequest)"> <summary> Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account. <note> <para> Currently, you can specify only one delivery channel per account. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeliveryChannels service method.</param> <returns>The response from the DescribeDeliveryChannels service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeDeliveryChannelsAsync(Amazon.ConfigService.Model.DescribeDeliveryChannelsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDeliveryChannels operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeliveryChannels operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeDeliveryChannelStatus"> <summary> Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account. <note>Currently, you can specify only one delivery channel per account.</note> </summary> <returns>The response from the DescribeDeliveryChannelStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeDeliveryChannelStatus(Amazon.ConfigService.Model.DescribeDeliveryChannelStatusRequest)"> <summary> Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account. <note>Currently, you can specify only one delivery channel per account.</note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeliveryChannelStatus service method.</param> <returns>The response from the DescribeDeliveryChannelStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeDeliveryChannelStatusAsync(Amazon.ConfigService.Model.DescribeDeliveryChannelStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDeliveryChannelStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeliveryChannelStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.GetComplianceDetailsByConfigRule(Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleRequest)"> <summary> Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceDetailsByConfigRule service method.</param> <returns>The response from the GetComplianceDetailsByConfigRule service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidNextTokenException"> The specified next token is invalid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.GetComplianceDetailsByConfigRuleAsync(Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetComplianceDetailsByConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceDetailsByConfigRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.GetComplianceDetailsByResource(Amazon.ConfigService.Model.GetComplianceDetailsByResourceRequest)"> <summary> Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceDetailsByResource service method.</param> <returns>The response from the GetComplianceDetailsByResource service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.GetComplianceDetailsByResourceAsync(Amazon.ConfigService.Model.GetComplianceDetailsByResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetComplianceDetailsByResource operation. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceDetailsByResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.GetComplianceSummaryByConfigRule(Amazon.ConfigService.Model.GetComplianceSummaryByConfigRuleRequest)"> <summary> Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceSummaryByConfigRule service method.</param> <returns>The response from the GetComplianceSummaryByConfigRule service method, as returned by ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.GetComplianceSummaryByConfigRuleAsync(Amazon.ConfigService.Model.GetComplianceSummaryByConfigRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetComplianceSummaryByConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceSummaryByConfigRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.GetComplianceSummaryByResourceType(Amazon.ConfigService.Model.GetComplianceSummaryByResourceTypeRequest)"> <summary> Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceSummaryByResourceType service method.</param> <returns>The response from the GetComplianceSummaryByResourceType service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.GetComplianceSummaryByResourceTypeAsync(Amazon.ConfigService.Model.GetComplianceSummaryByResourceTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetComplianceSummaryByResourceType operation. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceSummaryByResourceType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.GetResourceConfigHistory(Amazon.ConfigService.Model.GetResourceConfigHistoryRequest)"> <summary> Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval. <para> The response is paginated, and by default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string, and to get the next page of results, run the request again and enter this string for the <code>nextToken</code> parameter. </para> <note> <para> Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified <code>limit</code>. In such cases, you can make another call, using the <code>nextToken</code>. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the GetResourceConfigHistory service method.</param> <returns>The response from the GetResourceConfigHistory service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidLimitException"> The specified limit is outside the allowable range. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidNextTokenException"> The specified next token is invalid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidTimeRangeException"> The specified time range is not valid. The earlier time is not chronologically before the later time. </exception> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.ResourceNotDiscoveredException"> You have specified a resource that is either unknown or has not been discovered. </exception> <exception cref="T:Amazon.ConfigService.Model.ValidationException"> The requested action is not valid. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.GetResourceConfigHistoryAsync(Amazon.ConfigService.Model.GetResourceConfigHistoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetResourceConfigHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the GetResourceConfigHistory operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.ListDiscoveredResources(Amazon.ConfigService.Model.ListDiscoveredResourcesRequest)"> <summary> Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name. <note>You can specify either resource IDs or a resource name but not both in the same request.</note> <para> The response is paginated, and by default AWS Config lists 100 resource identifiers on each page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string, and to get the next page of results, run the request again and enter this string for the <code>nextToken</code> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListDiscoveredResources service method.</param> <returns>The response from the ListDiscoveredResources service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidLimitException"> The specified limit is outside the allowable range. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidNextTokenException"> The specified next token is invalid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results. </exception> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.ValidationException"> The requested action is not valid. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.ListDiscoveredResourcesAsync(Amazon.ConfigService.Model.ListDiscoveredResourcesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDiscoveredResources operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDiscoveredResources operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.PutConfigRule(Amazon.ConfigService.Model.PutConfigRuleRequest)"> <summary> Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations. <para> You can use this action for customer managed Config rules and AWS managed Config rules. A customer managed Config rule is a custom rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that is provided by AWS Config. </para> <para> If you are adding a new customer managed Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the <code>PutConfigRule</code> action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the <code>SourceIdentifier</code> key. This key is part of the <code>Source</code> object, which is part of the <code>ConfigRule</code> object. </para> <para> If you are adding a new AWS managed Config rule, specify the rule's identifier for the <code>SourceIdentifier</code> key. To reference AWS managed Config rule identifiers, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using AWS Managed Config Rules</a>. </para> <para> For any new rule that you add, specify the <code>ConfigRuleName</code> in the <code>ConfigRule</code> object. Do not specify the <code>ConfigRuleArn</code> or the <code>ConfigRuleId</code>. These values are generated by AWS Config for new rules. </para> <para> If you are updating a rule that you have added previously, specify the rule's <code>ConfigRuleName</code>, <code>ConfigRuleId</code>, or <code>ConfigRuleArn</code> in the <code>ConfigRule</code> data type that you use in this request. </para> <para> The maximum number of rules that AWS Config supports is 25. </para> <para> For more information about developing and using AWS Config rules, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html">Evaluating AWS Resource Configurations with AWS Config</a> in the <i>AWS Config Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutConfigRule service method.</param> <returns>The response from the PutConfigRule service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InsufficientPermissionsException"> Indicates one of the following errors: <ul> <li>The rule cannot be created because the IAM role assigned to AWS Config lacks permissions to perform the config:Put* action.</li> <li>The AWS Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.</li> </ul> </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.MaxNumberOfConfigRulesExceededException"> Failed to add the AWS Config rule because the account already contains the maximum number of 25 rules. Consider deleting any deactivated rules before adding new rules. </exception> <exception cref="T:Amazon.ConfigService.Model.ResourceInUseException"> The rule is currently being deleted. Wait for a while and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.PutConfigRuleAsync(Amazon.ConfigService.Model.PutConfigRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the PutConfigRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.PutConfigurationRecorder(Amazon.ConfigService.Model.PutConfigurationRecorderRequest)"> <summary> Creates a new configuration recorder to record the selected resource configurations. <para> You can use this action to change the role <code>roleARN</code> and/or the <code>recordingGroup</code> of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role. </para> <note> <para> Currently, you can specify only one configuration recorder per account. </para> <para> If <code>ConfigurationRecorder</code> does not have the <b>recordingGroup</b> parameter specified, the default is to record all supported resource types. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the PutConfigurationRecorder service method.</param> <returns>The response from the PutConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidConfigurationRecorderNameException"> You have provided a configuration recorder name that is not valid. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidRecordingGroupException"> AWS Config throws an exception if the recording group does not contain a valid list of resource types. Invalid values could also be incorrectly formatted. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidRoleException"> You have provided a null or empty role ARN. </exception> <exception cref="T:Amazon.ConfigService.Model.MaxNumberOfConfigurationRecordersExceededException"> You have reached the limit on the number of recorders you can create. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.PutConfigurationRecorderAsync(Amazon.ConfigService.Model.PutConfigurationRecorderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutConfigurationRecorder operation. </summary> <param name="request">Container for the necessary parameters to execute the PutConfigurationRecorder operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.PutDeliveryChannel(Amazon.ConfigService.Model.PutDeliveryChannelRequest)"> <summary> Creates a new delivery channel object to deliver the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic. <para> You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed. </para> <note> <para> Currently, you can specify only one delivery channel per account. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the PutDeliveryChannel service method.</param> <returns>The response from the PutDeliveryChannel service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InsufficientDeliveryPolicyException"> Your Amazon S3 bucket policy does not permit AWS Config to write to it. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidDeliveryChannelNameException"> The specified delivery channel name is not valid. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidS3KeyPrefixException"> The specified Amazon S3 key prefix is not valid. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidSNSTopicARNException"> The specified Amazon SNS topic does not exist. </exception> <exception cref="T:Amazon.ConfigService.Model.MaxNumberOfDeliveryChannelsExceededException"> You have reached the limit on the number of delivery channels you can create. </exception> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchBucketException"> The specified Amazon S3 bucket does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.PutDeliveryChannelAsync(Amazon.ConfigService.Model.PutDeliveryChannelRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutDeliveryChannel operation. </summary> <param name="request">Container for the necessary parameters to execute the PutDeliveryChannel operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.PutEvaluations(Amazon.ConfigService.Model.PutEvaluationsRequest)"> <summary> Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule. </summary> <param name="request">Container for the necessary parameters to execute the PutEvaluations service method.</param> <returns>The response from the PutEvaluations service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidResultTokenException"> The result token is invalid. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.PutEvaluationsAsync(Amazon.ConfigService.Model.PutEvaluationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutEvaluations operation. </summary> <param name="request">Container for the necessary parameters to execute the PutEvaluations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.StartConfigurationRecorder(System.String)"> <summary> Starts recording configurations of the AWS resources you have selected to record in your AWS account. <para> You must have created at least one delivery channel to successfully start the configuration recorder. </para> </summary> <param name="configurationRecorderName">The name of the recorder object that records each configuration change made to the resources.</param> <returns>The response from the StartConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoAvailableDeliveryChannelException"> There is no delivery channel available to record configurations. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.StartConfigurationRecorder(Amazon.ConfigService.Model.StartConfigurationRecorderRequest)"> <summary> Starts recording configurations of the AWS resources you have selected to record in your AWS account. <para> You must have created at least one delivery channel to successfully start the configuration recorder. </para> </summary> <param name="request">Container for the necessary parameters to execute the StartConfigurationRecorder service method.</param> <returns>The response from the StartConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoAvailableDeliveryChannelException"> There is no delivery channel available to record configurations. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.StartConfigurationRecorderAsync(Amazon.ConfigService.Model.StartConfigurationRecorderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartConfigurationRecorder operation. </summary> <param name="request">Container for the necessary parameters to execute the StartConfigurationRecorder operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.StopConfigurationRecorder(System.String)"> <summary> Stops recording configurations of the AWS resources you have selected to record in your AWS account. </summary> <param name="configurationRecorderName">The name of the recorder object that records each configuration change made to the resources.</param> <returns>The response from the StopConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.StopConfigurationRecorder(Amazon.ConfigService.Model.StopConfigurationRecorderRequest)"> <summary> Stops recording configurations of the AWS resources you have selected to record in your AWS account. </summary> <param name="request">Container for the necessary parameters to execute the StopConfigurationRecorder service method.</param> <returns>The response from the StopConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.StopConfigurationRecorderAsync(Amazon.ConfigService.Model.StopConfigurationRecorderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StopConfigurationRecorder operation. </summary> <param name="request">Container for the necessary parameters to execute the StopConfigurationRecorder operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor"> <summary> Constructs AmazonConfigServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonConfigServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(Amazon.ConfigService.AmazonConfigServiceConfig)"> <summary> Constructs AmazonConfigServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonConfigServiceClient Configuration Object</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonConfigServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonConfigServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.ConfigService.AmazonConfigServiceConfig)"> <summary> Constructs AmazonConfigServiceClient with AWS Credentials and an AmazonConfigServiceClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonConfigServiceClient Configuration Object</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonConfigServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonConfigServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(System.String,System.String,Amazon.ConfigService.AmazonConfigServiceConfig)"> <summary> Constructs AmazonConfigServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonConfigServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonConfigServiceClient Configuration Object</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonConfigServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonConfigServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(System.String,System.String,System.String,Amazon.ConfigService.AmazonConfigServiceConfig)"> <summary> Constructs AmazonConfigServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonConfigServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonConfigServiceClient Configuration Object</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DeleteConfigRule(Amazon.ConfigService.Model.DeleteConfigRuleRequest)"> <summary> Deletes the specified AWS Config rule and all of its evaluation results. <para> AWS Config sets the state of a rule to <code>DELETING</code> until the deletion is complete. You cannot update a rule while it is in this state. If you make a <code>PutConfigRule</code> request for the rule, you will receive a <code>ResourceInUseException</code>. </para> <para> You can check the state of a rule by using the <code>DescribeConfigRules</code> request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteConfigRule service method.</param> <returns>The response from the DeleteConfigRule service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.ResourceInUseException"> The rule is currently being deleted. Wait for a while and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DeleteConfigRuleAsync(Amazon.ConfigService.Model.DeleteConfigRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteConfigRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DeleteDeliveryChannel(System.String)"> <summary> Deletes the specified delivery channel. <para> The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the <a>StopConfigurationRecorder</a> action. </para> </summary> <param name="deliveryChannelName">The name of the delivery channel to delete.</param> <returns>The response from the DeleteDeliveryChannel service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.LastDeliveryChannelDeleteFailedException"> You cannot delete the delivery channel you specified because the configuration recorder is running. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DeleteDeliveryChannel(Amazon.ConfigService.Model.DeleteDeliveryChannelRequest)"> <summary> Deletes the specified delivery channel. <para> The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the <a>StopConfigurationRecorder</a> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeliveryChannel service method.</param> <returns>The response from the DeleteDeliveryChannel service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.LastDeliveryChannelDeleteFailedException"> You cannot delete the delivery channel you specified because the configuration recorder is running. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DeleteDeliveryChannelAsync(Amazon.ConfigService.Model.DeleteDeliveryChannelRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDeliveryChannel operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeliveryChannel operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DeliverConfigSnapshot(System.String)"> <summary> Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified. <ul> <li>Notification of starting the delivery.</li> <li>Notification of delivery completed, if the delivery was successfully completed.</li> <li>Notification of delivery failure, if the delivery failed to complete.</li> </ul> </summary> <param name="deliveryChannelName">The name of the delivery channel through which the snapshot is delivered.</param> <returns>The response from the DeliverConfigSnapshot service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.NoRunningConfigurationRecorderException"> There is no configuration recorder running. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DeliverConfigSnapshot(Amazon.ConfigService.Model.DeliverConfigSnapshotRequest)"> <summary> Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified. <ul> <li>Notification of starting the delivery.</li> <li>Notification of delivery completed, if the delivery was successfully completed.</li> <li>Notification of delivery failure, if the delivery failed to complete.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DeliverConfigSnapshot service method.</param> <returns>The response from the DeliverConfigSnapshot service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.NoRunningConfigurationRecorderException"> There is no configuration recorder running. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DeliverConfigSnapshotAsync(Amazon.ConfigService.Model.DeliverConfigSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeliverConfigSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeliverConfigSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeComplianceByConfigRule(Amazon.ConfigService.Model.DescribeComplianceByConfigRuleRequest)"> <summary> Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule. <para> A rule is compliant if all of the evaluated resources comply with it, and it is noncompliant if any of these resources do not comply. </para> <para> If AWS Config has no current evaluation results for the rule, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions: <ul> <li>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</li> <li>The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the <code>config:PutEvaluations</code> permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</li> <li>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</li></ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeComplianceByConfigRule service method.</param> <returns>The response from the DescribeComplianceByConfigRule service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeComplianceByConfigRuleAsync(Amazon.ConfigService.Model.DescribeComplianceByConfigRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeComplianceByConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeComplianceByConfigRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeComplianceByResource(Amazon.ConfigService.Model.DescribeComplianceByResourceRequest)"> <summary> Indicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with. <para> A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules. </para> <para> If AWS Config has no current evaluation results for the resource, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions about the rules that evaluate the resource: <ul> <li>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</li> <li>The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the <code>config:PutEvaluations</code> permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</li> <li>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</li></ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeComplianceByResource service method.</param> <returns>The response from the DescribeComplianceByResource service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidNextTokenException"> The specified next token is invalid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeComplianceByResourceAsync(Amazon.ConfigService.Model.DescribeComplianceByResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeComplianceByResource operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeComplianceByResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeConfigRuleEvaluationStatus(Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusRequest)"> <summary> Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigRuleEvaluationStatus service method.</param> <returns>The response from the DescribeConfigRuleEvaluationStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeConfigRuleEvaluationStatusAsync(Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConfigRuleEvaluationStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigRuleEvaluationStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeConfigRules(Amazon.ConfigService.Model.DescribeConfigRulesRequest)"> <summary> Returns details about your AWS Config rules. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigRules service method.</param> <returns>The response from the DescribeConfigRules service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeConfigRulesAsync(Amazon.ConfigService.Model.DescribeConfigRulesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConfigRules operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigRules operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeConfigurationRecorders"> <summary> Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account. <note> <para> Currently, you can specify only one configuration recorder per account. </para> </note> </summary> <returns>The response from the DescribeConfigurationRecorders service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeConfigurationRecorders(Amazon.ConfigService.Model.DescribeConfigurationRecordersRequest)"> <summary> Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account. <note> <para> Currently, you can specify only one configuration recorder per account. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationRecorders service method.</param> <returns>The response from the DescribeConfigurationRecorders service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeConfigurationRecordersAsync(Amazon.ConfigService.Model.DescribeConfigurationRecordersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConfigurationRecorders operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationRecorders operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeConfigurationRecorderStatus"> <summary> Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account. <note>Currently, you can specify only one configuration recorder per account.</note> </summary> <returns>The response from the DescribeConfigurationRecorderStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeConfigurationRecorderStatus(Amazon.ConfigService.Model.DescribeConfigurationRecorderStatusRequest)"> <summary> Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account. <note>Currently, you can specify only one configuration recorder per account.</note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationRecorderStatus service method.</param> <returns>The response from the DescribeConfigurationRecorderStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeConfigurationRecorderStatusAsync(Amazon.ConfigService.Model.DescribeConfigurationRecorderStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConfigurationRecorderStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationRecorderStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeDeliveryChannels"> <summary> Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account. <note> <para> Currently, you can specify only one delivery channel per account. </para> </note> </summary> <returns>The response from the DescribeDeliveryChannels service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeDeliveryChannels(Amazon.ConfigService.Model.DescribeDeliveryChannelsRequest)"> <summary> Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account. <note> <para> Currently, you can specify only one delivery channel per account. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeliveryChannels service method.</param> <returns>The response from the DescribeDeliveryChannels service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeDeliveryChannelsAsync(Amazon.ConfigService.Model.DescribeDeliveryChannelsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDeliveryChannels operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeliveryChannels operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeDeliveryChannelStatus"> <summary> Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account. <note>Currently, you can specify only one delivery channel per account.</note> </summary> <returns>The response from the DescribeDeliveryChannelStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeDeliveryChannelStatus(Amazon.ConfigService.Model.DescribeDeliveryChannelStatusRequest)"> <summary> Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account. <note>Currently, you can specify only one delivery channel per account.</note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeliveryChannelStatus service method.</param> <returns>The response from the DescribeDeliveryChannelStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeDeliveryChannelStatusAsync(Amazon.ConfigService.Model.DescribeDeliveryChannelStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDeliveryChannelStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeliveryChannelStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.GetComplianceDetailsByConfigRule(Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleRequest)"> <summary> Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceDetailsByConfigRule service method.</param> <returns>The response from the GetComplianceDetailsByConfigRule service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidNextTokenException"> The specified next token is invalid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.GetComplianceDetailsByConfigRuleAsync(Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetComplianceDetailsByConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceDetailsByConfigRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.GetComplianceDetailsByResource(Amazon.ConfigService.Model.GetComplianceDetailsByResourceRequest)"> <summary> Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceDetailsByResource service method.</param> <returns>The response from the GetComplianceDetailsByResource service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.GetComplianceDetailsByResourceAsync(Amazon.ConfigService.Model.GetComplianceDetailsByResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetComplianceDetailsByResource operation. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceDetailsByResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.GetComplianceSummaryByConfigRule(Amazon.ConfigService.Model.GetComplianceSummaryByConfigRuleRequest)"> <summary> Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceSummaryByConfigRule service method.</param> <returns>The response from the GetComplianceSummaryByConfigRule service method, as returned by ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.GetComplianceSummaryByConfigRuleAsync(Amazon.ConfigService.Model.GetComplianceSummaryByConfigRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetComplianceSummaryByConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceSummaryByConfigRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.GetComplianceSummaryByResourceType(Amazon.ConfigService.Model.GetComplianceSummaryByResourceTypeRequest)"> <summary> Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceSummaryByResourceType service method.</param> <returns>The response from the GetComplianceSummaryByResourceType service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.GetComplianceSummaryByResourceTypeAsync(Amazon.ConfigService.Model.GetComplianceSummaryByResourceTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetComplianceSummaryByResourceType operation. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceSummaryByResourceType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.GetResourceConfigHistory(Amazon.ConfigService.Model.GetResourceConfigHistoryRequest)"> <summary> Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval. <para> The response is paginated, and by default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string, and to get the next page of results, run the request again and enter this string for the <code>nextToken</code> parameter. </para> <note> <para> Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified <code>limit</code>. In such cases, you can make another call, using the <code>nextToken</code>. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the GetResourceConfigHistory service method.</param> <returns>The response from the GetResourceConfigHistory service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidLimitException"> The specified limit is outside the allowable range. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidNextTokenException"> The specified next token is invalid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidTimeRangeException"> The specified time range is not valid. The earlier time is not chronologically before the later time. </exception> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.ResourceNotDiscoveredException"> You have specified a resource that is either unknown or has not been discovered. </exception> <exception cref="T:Amazon.ConfigService.Model.ValidationException"> The requested action is not valid. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.GetResourceConfigHistoryAsync(Amazon.ConfigService.Model.GetResourceConfigHistoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetResourceConfigHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the GetResourceConfigHistory operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.ListDiscoveredResources(Amazon.ConfigService.Model.ListDiscoveredResourcesRequest)"> <summary> Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name. <note>You can specify either resource IDs or a resource name but not both in the same request.</note> <para> The response is paginated, and by default AWS Config lists 100 resource identifiers on each page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string, and to get the next page of results, run the request again and enter this string for the <code>nextToken</code> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListDiscoveredResources service method.</param> <returns>The response from the ListDiscoveredResources service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidLimitException"> The specified limit is outside the allowable range. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidNextTokenException"> The specified next token is invalid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results. </exception> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.ValidationException"> The requested action is not valid. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.ListDiscoveredResourcesAsync(Amazon.ConfigService.Model.ListDiscoveredResourcesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDiscoveredResources operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDiscoveredResources operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.PutConfigRule(Amazon.ConfigService.Model.PutConfigRuleRequest)"> <summary> Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations. <para> You can use this action for customer managed Config rules and AWS managed Config rules. A customer managed Config rule is a custom rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that is provided by AWS Config. </para> <para> If you are adding a new customer managed Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the <code>PutConfigRule</code> action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the <code>SourceIdentifier</code> key. This key is part of the <code>Source</code> object, which is part of the <code>ConfigRule</code> object. </para> <para> If you are adding a new AWS managed Config rule, specify the rule's identifier for the <code>SourceIdentifier</code> key. To reference AWS managed Config rule identifiers, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using AWS Managed Config Rules</a>. </para> <para> For any new rule that you add, specify the <code>ConfigRuleName</code> in the <code>ConfigRule</code> object. Do not specify the <code>ConfigRuleArn</code> or the <code>ConfigRuleId</code>. These values are generated by AWS Config for new rules. </para> <para> If you are updating a rule that you have added previously, specify the rule's <code>ConfigRuleName</code>, <code>ConfigRuleId</code>, or <code>ConfigRuleArn</code> in the <code>ConfigRule</code> data type that you use in this request. </para> <para> The maximum number of rules that AWS Config supports is 25. </para> <para> For more information about developing and using AWS Config rules, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html">Evaluating AWS Resource Configurations with AWS Config</a> in the <i>AWS Config Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutConfigRule service method.</param> <returns>The response from the PutConfigRule service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InsufficientPermissionsException"> Indicates one of the following errors: <ul> <li>The rule cannot be created because the IAM role assigned to AWS Config lacks permissions to perform the config:Put* action.</li> <li>The AWS Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.</li> </ul> </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.MaxNumberOfConfigRulesExceededException"> Failed to add the AWS Config rule because the account already contains the maximum number of 25 rules. Consider deleting any deactivated rules before adding new rules. </exception> <exception cref="T:Amazon.ConfigService.Model.ResourceInUseException"> The rule is currently being deleted. Wait for a while and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.PutConfigRuleAsync(Amazon.ConfigService.Model.PutConfigRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the PutConfigRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.PutConfigurationRecorder(Amazon.ConfigService.Model.PutConfigurationRecorderRequest)"> <summary> Creates a new configuration recorder to record the selected resource configurations. <para> You can use this action to change the role <code>roleARN</code> and/or the <code>recordingGroup</code> of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role. </para> <note> <para> Currently, you can specify only one configuration recorder per account. </para> <para> If <code>ConfigurationRecorder</code> does not have the <b>recordingGroup</b> parameter specified, the default is to record all supported resource types. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the PutConfigurationRecorder service method.</param> <returns>The response from the PutConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidConfigurationRecorderNameException"> You have provided a configuration recorder name that is not valid. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidRecordingGroupException"> AWS Config throws an exception if the recording group does not contain a valid list of resource types. Invalid values could also be incorrectly formatted. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidRoleException"> You have provided a null or empty role ARN. </exception> <exception cref="T:Amazon.ConfigService.Model.MaxNumberOfConfigurationRecordersExceededException"> You have reached the limit on the number of recorders you can create. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.PutConfigurationRecorderAsync(Amazon.ConfigService.Model.PutConfigurationRecorderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutConfigurationRecorder operation. </summary> <param name="request">Container for the necessary parameters to execute the PutConfigurationRecorder operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.PutDeliveryChannel(Amazon.ConfigService.Model.PutDeliveryChannelRequest)"> <summary> Creates a new delivery channel object to deliver the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic. <para> You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed. </para> <note> <para> Currently, you can specify only one delivery channel per account. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the PutDeliveryChannel service method.</param> <returns>The response from the PutDeliveryChannel service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InsufficientDeliveryPolicyException"> Your Amazon S3 bucket policy does not permit AWS Config to write to it. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidDeliveryChannelNameException"> The specified delivery channel name is not valid. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidS3KeyPrefixException"> The specified Amazon S3 key prefix is not valid. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidSNSTopicARNException"> The specified Amazon SNS topic does not exist. </exception> <exception cref="T:Amazon.ConfigService.Model.MaxNumberOfDeliveryChannelsExceededException"> You have reached the limit on the number of delivery channels you can create. </exception> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchBucketException"> The specified Amazon S3 bucket does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.PutDeliveryChannelAsync(Amazon.ConfigService.Model.PutDeliveryChannelRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutDeliveryChannel operation. </summary> <param name="request">Container for the necessary parameters to execute the PutDeliveryChannel operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.PutEvaluations(Amazon.ConfigService.Model.PutEvaluationsRequest)"> <summary> Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule. </summary> <param name="request">Container for the necessary parameters to execute the PutEvaluations service method.</param> <returns>The response from the PutEvaluations service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidResultTokenException"> The result token is invalid. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.PutEvaluationsAsync(Amazon.ConfigService.Model.PutEvaluationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutEvaluations operation. </summary> <param name="request">Container for the necessary parameters to execute the PutEvaluations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.StartConfigurationRecorder(System.String)"> <summary> Starts recording configurations of the AWS resources you have selected to record in your AWS account. <para> You must have created at least one delivery channel to successfully start the configuration recorder. </para> </summary> <param name="configurationRecorderName">The name of the recorder object that records each configuration change made to the resources.</param> <returns>The response from the StartConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoAvailableDeliveryChannelException"> There is no delivery channel available to record configurations. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.StartConfigurationRecorder(Amazon.ConfigService.Model.StartConfigurationRecorderRequest)"> <summary> Starts recording configurations of the AWS resources you have selected to record in your AWS account. <para> You must have created at least one delivery channel to successfully start the configuration recorder. </para> </summary> <param name="request">Container for the necessary parameters to execute the StartConfigurationRecorder service method.</param> <returns>The response from the StartConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoAvailableDeliveryChannelException"> There is no delivery channel available to record configurations. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.StartConfigurationRecorderAsync(Amazon.ConfigService.Model.StartConfigurationRecorderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartConfigurationRecorder operation. </summary> <param name="request">Container for the necessary parameters to execute the StartConfigurationRecorder operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.StopConfigurationRecorder(System.String)"> <summary> Stops recording configurations of the AWS resources you have selected to record in your AWS account. </summary> <param name="configurationRecorderName">The name of the recorder object that records each configuration change made to the resources.</param> <returns>The response from the StopConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.StopConfigurationRecorder(Amazon.ConfigService.Model.StopConfigurationRecorderRequest)"> <summary> Stops recording configurations of the AWS resources you have selected to record in your AWS account. </summary> <param name="request">Container for the necessary parameters to execute the StopConfigurationRecorder service method.</param> <returns>The response from the StopConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.StopConfigurationRecorderAsync(Amazon.ConfigService.Model.StopConfigurationRecorderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StopConfigurationRecorder operation. </summary> <param name="request">Container for the necessary parameters to execute the StopConfigurationRecorder operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient"> <summary> Implementation for accessing CloudWatchLogs Amazon CloudWatch Logs API Reference <para> You can use Amazon CloudWatch Logs to monitor, store, and access your log files from Amazon Elastic Compute Cloud (Amazon EC2) instances, Amazon CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the Amazon CloudWatch console, the CloudWatch Logs commands in the AWS CLI, the CloudWatch Logs API, or the CloudWatch Logs SDK. </para> <para> You can use CloudWatch Logs to: </para> <ul> <li> <para> <b>Monitor Logs from Amazon EC2 Instances in Real-time</b>: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException") or count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a Amazon CloudWatch metric that you specify. </para> </li> <li> <para> <b>Monitor Amazon CloudTrail Logged Events</b>: You can create alarms in Amazon CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting. </para> </li> <li> <para> <b>Archive Log Data</b>: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it. </para> </li> </ul> </summary> </member> <member name="T:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs"> <summary> Interface for accessing CloudWatchLogs Amazon CloudWatch Logs API Reference <para> You can use Amazon CloudWatch Logs to monitor, store, and access your log files from Amazon Elastic Compute Cloud (Amazon EC2) instances, Amazon CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the Amazon CloudWatch console, the CloudWatch Logs commands in the AWS CLI, the CloudWatch Logs API, or the CloudWatch Logs SDK. </para> <para> You can use CloudWatch Logs to: </para> <ul> <li> <para> <b>Monitor Logs from Amazon EC2 Instances in Real-time</b>: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException") or count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a Amazon CloudWatch metric that you specify. </para> </li> <li> <para> <b>Monitor Amazon CloudTrail Logged Events</b>: You can create alarms in Amazon CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting. </para> </li> <li> <para> <b>Archive Log Data</b>: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it. </para> </li> </ul> </summary> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.CancelExportTask(Amazon.CloudWatchLogs.Model.CancelExportTaskRequest)"> <summary> Cancels an export task if it is in <code>PENDING</code> or <code>RUNNING</code> state. </summary> <param name="request">Container for the necessary parameters to execute the CancelExportTask service method.</param> <returns>The response from the CancelExportTask service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidOperationException"> Returned if the operation is not valid on the specified resource </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.CancelExportTaskAsync(Amazon.CloudWatchLogs.Model.CancelExportTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelExportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelExportTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.CreateExportTask(Amazon.CloudWatchLogs.Model.CreateExportTaskRequest)"> <summary> Creates an <code>ExportTask</code> which allows you to efficiently export data from a Log Group to your Amazon S3 bucket. <para> This is an asynchronous call. If all the required information is provided, this API will initiate an export task and respond with the task Id. Once started, <code>DescribeExportTasks</code> can be used to get the status of an export task. You can only have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time, per account. </para> <para> You can export logs from multiple log groups or multiple time ranges to the same Amazon S3 bucket. To separate out log data for each export task, you can specify a prefix that will be used as the Amazon S3 key prefix for all exported objects. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateExportTask service method.</param> <returns>The response from the CreateExportTask service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> Returned if you have reached the maximum number of resources that can be created. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceAlreadyExistsException"> Returned if the specified resource already exists. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.CreateExportTaskAsync(Amazon.CloudWatchLogs.Model.CreateExportTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateExportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateExportTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.CreateLogGroup(Amazon.CloudWatchLogs.Model.CreateLogGroupRequest)"> <summary> Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account. <para> You must use the following guidelines when naming a log group: <ul> <li>Log group names can be between 1 and 512 characters long.</li> <li>Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLogGroup service method.</param> <returns>The response from the CreateLogGroup service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> Returned if you have reached the maximum number of resources that can be created. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceAlreadyExistsException"> Returned if the specified resource already exists. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.CreateLogGroupAsync(Amazon.CloudWatchLogs.Model.CreateLogGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLogGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLogGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.CreateLogStream(Amazon.CloudWatchLogs.Model.CreateLogStreamRequest)"> <summary> Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group. <para> You must use the following guidelines when naming a log stream: <ul> <li>Log stream names can be between 1 and 512 characters long.</li> <li>The ':' colon character is not allowed.</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLogStream service method.</param> <returns>The response from the CreateLogStream service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceAlreadyExistsException"> Returned if the specified resource already exists. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.CreateLogStreamAsync(Amazon.CloudWatchLogs.Model.CreateLogStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLogStream operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLogStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteDestination(Amazon.CloudWatchLogs.Model.DeleteDestinationRequest)"> <summary> Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDestination service method.</param> <returns>The response from the DeleteDestination service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteDestinationAsync(Amazon.CloudWatchLogs.Model.DeleteDestinationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDestination operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDestination operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteLogGroup(Amazon.CloudWatchLogs.Model.DeleteLogGroupRequest)"> <summary> Deletes the log group with the specified name and permanently deletes all the archived log events associated with it. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLogGroup service method.</param> <returns>The response from the DeleteLogGroup service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteLogGroupAsync(Amazon.CloudWatchLogs.Model.DeleteLogGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLogGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLogGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteLogStream(Amazon.CloudWatchLogs.Model.DeleteLogStreamRequest)"> <summary> Deletes a log stream and permanently deletes all the archived log events associated with it. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLogStream service method.</param> <returns>The response from the DeleteLogStream service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteLogStreamAsync(Amazon.CloudWatchLogs.Model.DeleteLogStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLogStream operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLogStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteMetricFilter(Amazon.CloudWatchLogs.Model.DeleteMetricFilterRequest)"> <summary> Deletes a metric filter associated with the specified log group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteMetricFilter service method.</param> <returns>The response from the DeleteMetricFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteMetricFilterAsync(Amazon.CloudWatchLogs.Model.DeleteMetricFilterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteMetricFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteMetricFilter operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteRetentionPolicy(Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyRequest)"> <summary> Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRetentionPolicy service method.</param> <returns>The response from the DeleteRetentionPolicy service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteRetentionPolicyAsync(Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRetentionPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRetentionPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteSubscriptionFilter(Amazon.CloudWatchLogs.Model.DeleteSubscriptionFilterRequest)"> <summary> Deletes a subscription filter associated with the specified log group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSubscriptionFilter service method.</param> <returns>The response from the DeleteSubscriptionFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteSubscriptionFilterAsync(Amazon.CloudWatchLogs.Model.DeleteSubscriptionFilterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSubscriptionFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSubscriptionFilter operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeDestinations(Amazon.CloudWatchLogs.Model.DescribeDestinationsRequest)"> <summary> Returns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name. <para> By default, this operation returns up to 50 destinations. If there are more destinations to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of destinations returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDestinations service method.</param> <returns>The response from the DescribeDestinations service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeDestinationsAsync(Amazon.CloudWatchLogs.Model.DescribeDestinationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDestinations operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDestinations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeExportTasks(Amazon.CloudWatchLogs.Model.DescribeExportTasksRequest)"> <summary> Returns all the export tasks that are associated with the AWS account making the request. The export tasks can be filtered based on <code>TaskId</code> or <code>TaskStatus</code>. <para> By default, this operation returns up to 50 export tasks that satisfy the specified filters. If there are more export tasks to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of export tasks returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeExportTasks service method.</param> <returns>The response from the DescribeExportTasks service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeExportTasksAsync(Amazon.CloudWatchLogs.Model.DescribeExportTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeExportTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExportTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeLogGroups"> <summary> Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name. <para> By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of log groups returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <returns>The response from the DescribeLogGroups service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeLogGroups(Amazon.CloudWatchLogs.Model.DescribeLogGroupsRequest)"> <summary> Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name. <para> By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of log groups returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLogGroups service method.</param> <returns>The response from the DescribeLogGroups service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeLogGroupsAsync(Amazon.CloudWatchLogs.Model.DescribeLogGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLogGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLogGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeLogStreams(Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest)"> <summary> Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name. <para> By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of log streams returned in the response by specifying the <code class="code">limit</code> parameter in the request. This operation has a limit of five transactions per second, after which transactions are throttled. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLogStreams service method.</param> <returns>The response from the DescribeLogStreams service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeLogStreamsAsync(Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLogStreams operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLogStreams operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeMetricFilters(Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest)"> <summary> Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name. <para> By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of metric filters returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeMetricFilters service method.</param> <returns>The response from the DescribeMetricFilters service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeMetricFiltersAsync(Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeMetricFilters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMetricFilters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeSubscriptionFilters(Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersRequest)"> <summary> Returns all the subscription filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name. <para> By default, this operation returns up to 50 subscription filters. If there are more subscription filters to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of subscription filters returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSubscriptionFilters service method.</param> <returns>The response from the DescribeSubscriptionFilters service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeSubscriptionFiltersAsync(Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSubscriptionFilters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSubscriptionFilters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.FilterLogEvents(Amazon.CloudWatchLogs.Model.FilterLogEventsRequest)"> <summary> Retrieves log events, optionally filtered by a filter pattern from the specified log group. You can provide an optional time range to filter the results on the event <code class="code">timestamp</code>. You can limit the streams searched to an explicit list of <code class="code">logStreamNames</code>. <para> By default, this operation returns as much matching log events as can fit in a response size of 1MB, up to 10,000 log events, or all the events found within a time-bounded scan window. If the response includes a <code class="code">nextToken</code>, then there is more data to search, and the search can be resumed with a new request providing the nextToken. The response will contain a list of <code class="code">searchedLogStreams</code> that contains information about which streams were searched in the request and whether they have been searched completely or require further pagination. The <code class="code">limit</code> parameter in the request. can be used to specify the maximum number of events to return in a page. </para> </summary> <param name="request">Container for the necessary parameters to execute the FilterLogEvents service method.</param> <returns>The response from the FilterLogEvents service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.FilterLogEventsAsync(Amazon.CloudWatchLogs.Model.FilterLogEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the FilterLogEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the FilterLogEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.GetLogEvents(Amazon.CloudWatchLogs.Model.GetLogEventsRequest)"> <summary> Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event <code class="code">timestamp</code>. <para> By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a <code class="code">nextForwardToken</code> and a <code class="code">nextBackwardToken</code> in the response body. You can use any of these tokens in subsequent <code class="code">GetLogEvents</code> requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetLogEvents service method.</param> <returns>The response from the GetLogEvents service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.GetLogEventsAsync(Amazon.CloudWatchLogs.Model.GetLogEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetLogEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the GetLogEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutDestination(Amazon.CloudWatchLogs.Model.PutDestinationRequest)"> <summary> Creates or updates a <code>Destination</code>. A destination encapsulates a physical resource (such as a Kinesis stream) and allows you to subscribe to a real-time stream of log events of a different account, ingested through <code class="code">PutLogEvents</code> requests. Currently, the only supported physical resource is a Amazon Kinesis stream belonging to the same account as the destination. <para> A destination controls what is written to its Amazon Kinesis stream through an access policy. By default, PutDestination does not set any access policy with the destination, which means a cross-account user will not be able to call <code>PutSubscriptionFilter</code> against this destination. To enable that, the destination owner must call <code>PutDestinationPolicy</code> after PutDestination. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutDestination service method.</param> <returns>The response from the PutDestination service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutDestinationAsync(Amazon.CloudWatchLogs.Model.PutDestinationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutDestination operation. </summary> <param name="request">Container for the necessary parameters to execute the PutDestination operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutDestinationPolicy(Amazon.CloudWatchLogs.Model.PutDestinationPolicyRequest)"> <summary> Creates or updates an access policy associated with an existing <code>Destination</code>. An access policy is an <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html">IAM policy document</a> that is used to authorize claims to register a subscription filter against a given destination. </summary> <param name="request">Container for the necessary parameters to execute the PutDestinationPolicy service method.</param> <returns>The response from the PutDestinationPolicy service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutDestinationPolicyAsync(Amazon.CloudWatchLogs.Model.PutDestinationPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutDestinationPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutDestinationPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutLogEvents(Amazon.CloudWatchLogs.Model.PutLogEventsRequest)"> <summary> Uploads a batch of log events to the specified log stream. <para> Every PutLogEvents request must include the <code class="code">sequenceToken</code> obtained from the response of the previous request. An upload in a newly created log stream does not require a <code class="code">sequenceToken</code>. </para> <para> The batch of events must satisfy the following constraints: <ul> <li>The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.</li> <li>None of the log events in the batch can be more than 2 hours in the future.</li> <li>None of the log events in the batch can be older than 14 days or the retention period of the log group.</li> <li>The log events in the batch must be in chronological ordered by their <code class="code">timestamp</code>.</li> <li>The maximum number of log events in a batch is 10,000.</li> <li>A batch of log events in a single PutLogEvents request cannot span more than 24 hours. Otherwise, the PutLogEvents operation will fail.</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the PutLogEvents service method.</param> <returns>The response from the PutLogEvents service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.DataAlreadyAcceptedException"> </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidSequenceTokenException"> </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutLogEventsAsync(Amazon.CloudWatchLogs.Model.PutLogEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutLogEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the PutLogEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutMetricFilter(Amazon.CloudWatchLogs.Model.PutMetricFilterRequest)"> <summary> Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through <code class="code">PutLogEvents</code> requests. <para> The maximum number of metric filters that can be associated with a log group is 100. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutMetricFilter service method.</param> <returns>The response from the PutMetricFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> Returned if you have reached the maximum number of resources that can be created. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutMetricFilterAsync(Amazon.CloudWatchLogs.Model.PutMetricFilterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutMetricFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the PutMetricFilter operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutRetentionPolicy(Amazon.CloudWatchLogs.Model.PutRetentionPolicyRequest)"> <summary> Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group. </summary> <param name="request">Container for the necessary parameters to execute the PutRetentionPolicy service method.</param> <returns>The response from the PutRetentionPolicy service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutRetentionPolicyAsync(Amazon.CloudWatchLogs.Model.PutRetentionPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutRetentionPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutRetentionPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutSubscriptionFilter(Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest)"> <summary> Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through <code class="code">PutLogEvents</code> requests and have them delivered to a specific destination. Currently, the supported destinations are: <ul> <li> An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery. </li> <li> A logical destination (used via an ARN of <code>Destination</code>) belonging to a different account, for cross-account delivery. </li> <li> An Amazon Kinesis Firehose stream belonging to the same account as the subscription filter, for same-account delivery. </li> <li> An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery. </li> </ul> <para> Currently there can only be one subscription filter associated with a log group. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutSubscriptionFilter service method.</param> <returns>The response from the PutSubscriptionFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> Returned if you have reached the maximum number of resources that can be created. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutSubscriptionFilterAsync(Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutSubscriptionFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the PutSubscriptionFilter operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.TestMetricFilter(Amazon.CloudWatchLogs.Model.TestMetricFilterRequest)"> <summary> Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern. </summary> <param name="request">Container for the necessary parameters to execute the TestMetricFilter service method.</param> <returns>The response from the TestMetricFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.TestMetricFilterAsync(Amazon.CloudWatchLogs.Model.TestMetricFilterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TestMetricFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the TestMetricFilter operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor"> <summary> Constructs AmazonCloudWatchLogsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudWatchLogsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(Amazon.CloudWatchLogs.AmazonCloudWatchLogsConfig)"> <summary> Constructs AmazonCloudWatchLogsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudWatchLogsClient Configuration Object</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudWatchLogs.AmazonCloudWatchLogsConfig)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Credentials and an AmazonCloudWatchLogsClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudWatchLogsClient Configuration Object</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(System.String,System.String,Amazon.CloudWatchLogs.AmazonCloudWatchLogsConfig)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchLogsClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudWatchLogsClient Configuration Object</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(System.String,System.String,System.String,Amazon.CloudWatchLogs.AmazonCloudWatchLogsConfig)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchLogsClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudWatchLogsClient Configuration Object</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.CancelExportTask(Amazon.CloudWatchLogs.Model.CancelExportTaskRequest)"> <summary> Cancels an export task if it is in <code>PENDING</code> or <code>RUNNING</code> state. </summary> <param name="request">Container for the necessary parameters to execute the CancelExportTask service method.</param> <returns>The response from the CancelExportTask service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidOperationException"> Returned if the operation is not valid on the specified resource </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.CancelExportTaskAsync(Amazon.CloudWatchLogs.Model.CancelExportTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelExportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelExportTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.CreateExportTask(Amazon.CloudWatchLogs.Model.CreateExportTaskRequest)"> <summary> Creates an <code>ExportTask</code> which allows you to efficiently export data from a Log Group to your Amazon S3 bucket. <para> This is an asynchronous call. If all the required information is provided, this API will initiate an export task and respond with the task Id. Once started, <code>DescribeExportTasks</code> can be used to get the status of an export task. You can only have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time, per account. </para> <para> You can export logs from multiple log groups or multiple time ranges to the same Amazon S3 bucket. To separate out log data for each export task, you can specify a prefix that will be used as the Amazon S3 key prefix for all exported objects. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateExportTask service method.</param> <returns>The response from the CreateExportTask service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> Returned if you have reached the maximum number of resources that can be created. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceAlreadyExistsException"> Returned if the specified resource already exists. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.CreateExportTaskAsync(Amazon.CloudWatchLogs.Model.CreateExportTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateExportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateExportTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.CreateLogGroup(Amazon.CloudWatchLogs.Model.CreateLogGroupRequest)"> <summary> Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account. <para> You must use the following guidelines when naming a log group: <ul> <li>Log group names can be between 1 and 512 characters long.</li> <li>Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLogGroup service method.</param> <returns>The response from the CreateLogGroup service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> Returned if you have reached the maximum number of resources that can be created. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceAlreadyExistsException"> Returned if the specified resource already exists. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.CreateLogGroupAsync(Amazon.CloudWatchLogs.Model.CreateLogGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLogGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLogGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.CreateLogStream(Amazon.CloudWatchLogs.Model.CreateLogStreamRequest)"> <summary> Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group. <para> You must use the following guidelines when naming a log stream: <ul> <li>Log stream names can be between 1 and 512 characters long.</li> <li>The ':' colon character is not allowed.</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLogStream service method.</param> <returns>The response from the CreateLogStream service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceAlreadyExistsException"> Returned if the specified resource already exists. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.CreateLogStreamAsync(Amazon.CloudWatchLogs.Model.CreateLogStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLogStream operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLogStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteDestination(Amazon.CloudWatchLogs.Model.DeleteDestinationRequest)"> <summary> Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDestination service method.</param> <returns>The response from the DeleteDestination service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteDestinationAsync(Amazon.CloudWatchLogs.Model.DeleteDestinationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDestination operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDestination operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteLogGroup(Amazon.CloudWatchLogs.Model.DeleteLogGroupRequest)"> <summary> Deletes the log group with the specified name and permanently deletes all the archived log events associated with it. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLogGroup service method.</param> <returns>The response from the DeleteLogGroup service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteLogGroupAsync(Amazon.CloudWatchLogs.Model.DeleteLogGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLogGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLogGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteLogStream(Amazon.CloudWatchLogs.Model.DeleteLogStreamRequest)"> <summary> Deletes a log stream and permanently deletes all the archived log events associated with it. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLogStream service method.</param> <returns>The response from the DeleteLogStream service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteLogStreamAsync(Amazon.CloudWatchLogs.Model.DeleteLogStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLogStream operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLogStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteMetricFilter(Amazon.CloudWatchLogs.Model.DeleteMetricFilterRequest)"> <summary> Deletes a metric filter associated with the specified log group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteMetricFilter service method.</param> <returns>The response from the DeleteMetricFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteMetricFilterAsync(Amazon.CloudWatchLogs.Model.DeleteMetricFilterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteMetricFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteMetricFilter operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteRetentionPolicy(Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyRequest)"> <summary> Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRetentionPolicy service method.</param> <returns>The response from the DeleteRetentionPolicy service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteRetentionPolicyAsync(Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRetentionPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRetentionPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteSubscriptionFilter(Amazon.CloudWatchLogs.Model.DeleteSubscriptionFilterRequest)"> <summary> Deletes a subscription filter associated with the specified log group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSubscriptionFilter service method.</param> <returns>The response from the DeleteSubscriptionFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteSubscriptionFilterAsync(Amazon.CloudWatchLogs.Model.DeleteSubscriptionFilterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSubscriptionFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSubscriptionFilter operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeDestinations(Amazon.CloudWatchLogs.Model.DescribeDestinationsRequest)"> <summary> Returns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name. <para> By default, this operation returns up to 50 destinations. If there are more destinations to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of destinations returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDestinations service method.</param> <returns>The response from the DescribeDestinations service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeDestinationsAsync(Amazon.CloudWatchLogs.Model.DescribeDestinationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDestinations operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDestinations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeExportTasks(Amazon.CloudWatchLogs.Model.DescribeExportTasksRequest)"> <summary> Returns all the export tasks that are associated with the AWS account making the request. The export tasks can be filtered based on <code>TaskId</code> or <code>TaskStatus</code>. <para> By default, this operation returns up to 50 export tasks that satisfy the specified filters. If there are more export tasks to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of export tasks returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeExportTasks service method.</param> <returns>The response from the DescribeExportTasks service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeExportTasksAsync(Amazon.CloudWatchLogs.Model.DescribeExportTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeExportTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExportTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeLogGroups"> <summary> Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name. <para> By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of log groups returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <returns>The response from the DescribeLogGroups service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeLogGroups(Amazon.CloudWatchLogs.Model.DescribeLogGroupsRequest)"> <summary> Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name. <para> By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of log groups returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLogGroups service method.</param> <returns>The response from the DescribeLogGroups service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeLogGroupsAsync(Amazon.CloudWatchLogs.Model.DescribeLogGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLogGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLogGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeLogStreams(Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest)"> <summary> Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name. <para> By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of log streams returned in the response by specifying the <code class="code">limit</code> parameter in the request. This operation has a limit of five transactions per second, after which transactions are throttled. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLogStreams service method.</param> <returns>The response from the DescribeLogStreams service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeLogStreamsAsync(Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLogStreams operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLogStreams operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeMetricFilters(Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest)"> <summary> Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name. <para> By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of metric filters returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeMetricFilters service method.</param> <returns>The response from the DescribeMetricFilters service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeMetricFiltersAsync(Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeMetricFilters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMetricFilters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeSubscriptionFilters(Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersRequest)"> <summary> Returns all the subscription filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name. <para> By default, this operation returns up to 50 subscription filters. If there are more subscription filters to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of subscription filters returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSubscriptionFilters service method.</param> <returns>The response from the DescribeSubscriptionFilters service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeSubscriptionFiltersAsync(Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSubscriptionFilters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSubscriptionFilters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.FilterLogEvents(Amazon.CloudWatchLogs.Model.FilterLogEventsRequest)"> <summary> Retrieves log events, optionally filtered by a filter pattern from the specified log group. You can provide an optional time range to filter the results on the event <code class="code">timestamp</code>. You can limit the streams searched to an explicit list of <code class="code">logStreamNames</code>. <para> By default, this operation returns as much matching log events as can fit in a response size of 1MB, up to 10,000 log events, or all the events found within a time-bounded scan window. If the response includes a <code class="code">nextToken</code>, then there is more data to search, and the search can be resumed with a new request providing the nextToken. The response will contain a list of <code class="code">searchedLogStreams</code> that contains information about which streams were searched in the request and whether they have been searched completely or require further pagination. The <code class="code">limit</code> parameter in the request. can be used to specify the maximum number of events to return in a page. </para> </summary> <param name="request">Container for the necessary parameters to execute the FilterLogEvents service method.</param> <returns>The response from the FilterLogEvents service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.FilterLogEventsAsync(Amazon.CloudWatchLogs.Model.FilterLogEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the FilterLogEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the FilterLogEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.GetLogEvents(Amazon.CloudWatchLogs.Model.GetLogEventsRequest)"> <summary> Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event <code class="code">timestamp</code>. <para> By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a <code class="code">nextForwardToken</code> and a <code class="code">nextBackwardToken</code> in the response body. You can use any of these tokens in subsequent <code class="code">GetLogEvents</code> requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetLogEvents service method.</param> <returns>The response from the GetLogEvents service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.GetLogEventsAsync(Amazon.CloudWatchLogs.Model.GetLogEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetLogEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the GetLogEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutDestination(Amazon.CloudWatchLogs.Model.PutDestinationRequest)"> <summary> Creates or updates a <code>Destination</code>. A destination encapsulates a physical resource (such as a Kinesis stream) and allows you to subscribe to a real-time stream of log events of a different account, ingested through <code class="code">PutLogEvents</code> requests. Currently, the only supported physical resource is a Amazon Kinesis stream belonging to the same account as the destination. <para> A destination controls what is written to its Amazon Kinesis stream through an access policy. By default, PutDestination does not set any access policy with the destination, which means a cross-account user will not be able to call <code>PutSubscriptionFilter</code> against this destination. To enable that, the destination owner must call <code>PutDestinationPolicy</code> after PutDestination. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutDestination service method.</param> <returns>The response from the PutDestination service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutDestinationAsync(Amazon.CloudWatchLogs.Model.PutDestinationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutDestination operation. </summary> <param name="request">Container for the necessary parameters to execute the PutDestination operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutDestinationPolicy(Amazon.CloudWatchLogs.Model.PutDestinationPolicyRequest)"> <summary> Creates or updates an access policy associated with an existing <code>Destination</code>. An access policy is an <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html">IAM policy document</a> that is used to authorize claims to register a subscription filter against a given destination. </summary> <param name="request">Container for the necessary parameters to execute the PutDestinationPolicy service method.</param> <returns>The response from the PutDestinationPolicy service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutDestinationPolicyAsync(Amazon.CloudWatchLogs.Model.PutDestinationPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutDestinationPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutDestinationPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutLogEvents(Amazon.CloudWatchLogs.Model.PutLogEventsRequest)"> <summary> Uploads a batch of log events to the specified log stream. <para> Every PutLogEvents request must include the <code class="code">sequenceToken</code> obtained from the response of the previous request. An upload in a newly created log stream does not require a <code class="code">sequenceToken</code>. </para> <para> The batch of events must satisfy the following constraints: <ul> <li>The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.</li> <li>None of the log events in the batch can be more than 2 hours in the future.</li> <li>None of the log events in the batch can be older than 14 days or the retention period of the log group.</li> <li>The log events in the batch must be in chronological ordered by their <code class="code">timestamp</code>.</li> <li>The maximum number of log events in a batch is 10,000.</li> <li>A batch of log events in a single PutLogEvents request cannot span more than 24 hours. Otherwise, the PutLogEvents operation will fail.</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the PutLogEvents service method.</param> <returns>The response from the PutLogEvents service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.DataAlreadyAcceptedException"> </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidSequenceTokenException"> </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutLogEventsAsync(Amazon.CloudWatchLogs.Model.PutLogEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutLogEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the PutLogEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutMetricFilter(Amazon.CloudWatchLogs.Model.PutMetricFilterRequest)"> <summary> Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through <code class="code">PutLogEvents</code> requests. <para> The maximum number of metric filters that can be associated with a log group is 100. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutMetricFilter service method.</param> <returns>The response from the PutMetricFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> Returned if you have reached the maximum number of resources that can be created. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutMetricFilterAsync(Amazon.CloudWatchLogs.Model.PutMetricFilterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutMetricFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the PutMetricFilter operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutRetentionPolicy(Amazon.CloudWatchLogs.Model.PutRetentionPolicyRequest)"> <summary> Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group. </summary> <param name="request">Container for the necessary parameters to execute the PutRetentionPolicy service method.</param> <returns>The response from the PutRetentionPolicy service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutRetentionPolicyAsync(Amazon.CloudWatchLogs.Model.PutRetentionPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutRetentionPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutRetentionPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutSubscriptionFilter(Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest)"> <summary> Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through <code class="code">PutLogEvents</code> requests and have them delivered to a specific destination. Currently, the supported destinations are: <ul> <li> An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery. </li> <li> A logical destination (used via an ARN of <code>Destination</code>) belonging to a different account, for cross-account delivery. </li> <li> An Amazon Kinesis Firehose stream belonging to the same account as the subscription filter, for same-account delivery. </li> <li> An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery. </li> </ul> <para> Currently there can only be one subscription filter associated with a log group. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutSubscriptionFilter service method.</param> <returns>The response from the PutSubscriptionFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> Returned if you have reached the maximum number of resources that can be created. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutSubscriptionFilterAsync(Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutSubscriptionFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the PutSubscriptionFilter operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.TestMetricFilter(Amazon.CloudWatchLogs.Model.TestMetricFilterRequest)"> <summary> Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern. </summary> <param name="request">Container for the necessary parameters to execute the TestMetricFilter service method.</param> <returns>The response from the TestMetricFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.TestMetricFilterAsync(Amazon.CloudWatchLogs.Model.TestMetricFilterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TestMetricFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the TestMetricFilter operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.CloudWatch.AmazonCloudWatchClient"> <summary> Implementation for accessing CloudWatch Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real-time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications. <para> CloudWatch alarms send notifications or automatically make changes to the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon Elastic Compute Cloud (Amazon EC2) instances and then use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money. </para> <para> In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health. </para> </summary> </member> <member name="T:Amazon.CloudWatch.IAmazonCloudWatch"> <summary> Interface for accessing CloudWatch Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real-time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications. <para> CloudWatch alarms send notifications or automatically make changes to the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon Elastic Compute Cloud (Amazon EC2) instances and then use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money. </para> <para> In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health. </para> </summary> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DeleteAlarms(Amazon.CloudWatch.Model.DeleteAlarmsRequest)"> <summary> Deletes all specified alarms. In the event of an error, no alarms are deleted. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAlarms service method.</param> <returns>The response from the DeleteAlarms service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.ResourceNotFoundException"> The named resource does not exist. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DeleteAlarmsAsync(Amazon.CloudWatch.Model.DeleteAlarmsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAlarms operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAlarms operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DescribeAlarmHistory"> <summary> Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms. <note> Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. </note> </summary> <returns>The response from the DescribeAlarmHistory service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> The next token specified is invalid. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DescribeAlarmHistory(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest)"> <summary> Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms. <note> Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarmHistory service method.</param> <returns>The response from the DescribeAlarmHistory service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> The next token specified is invalid. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DescribeAlarmHistoryAsync(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAlarmHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarmHistory operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DescribeAlarms"> <summary> Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action. </summary> <returns>The response from the DescribeAlarms service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> The next token specified is invalid. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DescribeAlarms(Amazon.CloudWatch.Model.DescribeAlarmsRequest)"> <summary> Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarms service method.</param> <returns>The response from the DescribeAlarms service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> The next token specified is invalid. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DescribeAlarmsAsync(Amazon.CloudWatch.Model.DescribeAlarmsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAlarms operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarms operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DescribeAlarmsForMetric(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest)"> <summary> Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarmsForMetric service method.</param> <returns>The response from the DescribeAlarmsForMetric service method, as returned by CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DescribeAlarmsForMetricAsync(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAlarmsForMetric operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarmsForMetric operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DisableAlarmActions(Amazon.CloudWatch.Model.DisableAlarmActionsRequest)"> <summary> Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute. </summary> <param name="request">Container for the necessary parameters to execute the DisableAlarmActions service method.</param> <returns>The response from the DisableAlarmActions service method, as returned by CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DisableAlarmActionsAsync(Amazon.CloudWatch.Model.DisableAlarmActionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableAlarmActions operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableAlarmActions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.EnableAlarmActions(Amazon.CloudWatch.Model.EnableAlarmActionsRequest)"> <summary> Enables actions for the specified alarms. </summary> <param name="request">Container for the necessary parameters to execute the EnableAlarmActions service method.</param> <returns>The response from the EnableAlarmActions service method, as returned by CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.EnableAlarmActionsAsync(Amazon.CloudWatch.Model.EnableAlarmActionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableAlarmActions operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableAlarmActions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.GetMetricStatistics(Amazon.CloudWatch.Model.GetMetricStatisticsRequest)"> <summary> Gets statistics for the specified metric. <para> The maximum number of data points that can be queried is 50,850, whereas the maximum number of data points returned from a single <code>GetMetricStatistics</code> request is 1,440. If you make a request that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, you can alter the request by narrowing the specified time range or increasing the specified period. Alternatively, you can make multiple requests across adjacent time ranges. <code>GetMetricStatistics</code> does not return the data in chronological order. </para> <para> Amazon CloudWatch aggregates data points based on the length of the <code>period</code> that you specify. For example, if you request statistics with a one-minute granularity, Amazon CloudWatch aggregates data points with time stamps that fall within the same one-minute period. In such a case, the data points queried can greatly outnumber the data points returned. </para> <para> The following examples show various statistics allowed by the data point query maximum of 50,850 when you call <code>GetMetricStatistics</code> on Amazon EC2 instances with detailed (one-minute) monitoring enabled: </para> <ul> <li>Statistics for up to 400 instances for a span of one hour</li> <li>Statistics for up to 35 instances over a span of 24 hours</li> <li>Statistics for up to 2 instances over a span of 2 weeks</li> </ul> <para> For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to CloudWatch, go to <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html">Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference</a> in the <i>Amazon CloudWatch Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetMetricStatistics service method.</param> <returns>The response from the GetMetricStatistics service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"> Indicates that the request processing has failed due to some unknown error, exception, or failure. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterCombinationException"> Parameters that must not be used together were used together. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> Bad or out-of-range value was supplied for the input parameter. </exception> <exception cref="T:Amazon.CloudWatch.Model.MissingRequiredParameterException"> An input parameter that is mandatory for processing the request is not supplied. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.GetMetricStatisticsAsync(Amazon.CloudWatch.Model.GetMetricStatisticsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetMetricStatistics operation. </summary> <param name="request">Container for the necessary parameters to execute the GetMetricStatistics operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.ListMetrics"> <summary> Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with <a>GetMetricStatistics</a> to obtain statistical data for a given metric. <note> Up to 500 results are returned for any one call. To retrieve further results, use returned <code>NextToken</code> values with subsequent <code>ListMetrics</code> operations. </note> <note> If you create a metric with the <a>PutMetricData</a> action, allow up to fifteen minutes for the metric to appear in calls to the <code>ListMetrics</code> action. Statistics about the metric, however, are available sooner using <a>GetMetricStatistics</a>. </note> </summary> <returns>The response from the ListMetrics service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"> Indicates that the request processing has failed due to some unknown error, exception, or failure. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> Bad or out-of-range value was supplied for the input parameter. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.ListMetrics(Amazon.CloudWatch.Model.ListMetricsRequest)"> <summary> Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with <a>GetMetricStatistics</a> to obtain statistical data for a given metric. <note> Up to 500 results are returned for any one call. To retrieve further results, use returned <code>NextToken</code> values with subsequent <code>ListMetrics</code> operations. </note> <note> If you create a metric with the <a>PutMetricData</a> action, allow up to fifteen minutes for the metric to appear in calls to the <code>ListMetrics</code> action. Statistics about the metric, however, are available sooner using <a>GetMetricStatistics</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the ListMetrics service method.</param> <returns>The response from the ListMetrics service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"> Indicates that the request processing has failed due to some unknown error, exception, or failure. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> Bad or out-of-range value was supplied for the input parameter. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.ListMetricsAsync(Amazon.CloudWatch.Model.ListMetricsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListMetrics operation. </summary> <param name="request">Container for the necessary parameters to execute the ListMetrics operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.PutMetricAlarm(Amazon.CloudWatch.Model.PutMetricAlarmRequest)"> <summary> Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm. <para> When this operation creates an alarm, the alarm state is immediately set to <code>INSUFFICIENT_DATA</code>. The alarm is evaluated and its <code>StateValue</code> is set appropriately. Any actions associated with the <code>StateValue</code> is then executed. </para> <note> When updating an existing alarm, its <code>StateValue</code> is left unchanged. </note> <note> If you are using an AWS Identity and Access Management (IAM) account to create or modify an alarm, you must have the following Amazon EC2 permissions: <ul> <li><code>ec2:DescribeInstanceStatus</code> and <code>ec2:DescribeInstances</code> for all alarms on Amazon EC2 instance status metrics.</li> <li><code>ec2:StopInstances</code> for alarms with stop actions.</li> <li><code>ec2:TerminateInstances</code> for alarms with terminate actions.</li> <li><code>ec2:DescribeInstanceRecoveryAttribute</code>, and <code>ec2:RecoverInstances</code> for alarms with recover actions.</li> </ul> <para> If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm but the stop or terminate actions won't be performed on the Amazon EC2 instance. However, if you are later granted permission to use the associated Amazon EC2 APIs, the alarm actions you created earlier will be performed. For more information about IAM permissions, see <a href="http://docs.aws.amazon.com//IAM/latest/UserGuide/PermissionsAndPolicies.html">Permissions and Policies</a> in <i>Using IAM</i>. </para> <para> If you are using an IAM role (e.g., an Amazon EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies. </para> <para> If you are using temporary security credentials granted using the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the PutMetricAlarm service method.</param> <returns>The response from the PutMetricAlarm service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.LimitExceededException"> The quota for alarms for this customer has already been reached. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.PutMetricAlarmAsync(Amazon.CloudWatch.Model.PutMetricAlarmRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutMetricAlarm operation. </summary> <param name="request">Container for the necessary parameters to execute the PutMetricAlarm operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.PutMetricData(Amazon.CloudWatch.Model.PutMetricDataRequest)"> <summary> Publishes metric data points to Amazon CloudWatch. Amazon CloudWatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric. When Amazon CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to the <a>ListMetrics</a> action. <para> Each <code>PutMetricData</code> request is limited to 8 KB in size for HTTP GET requests and is limited to 40 KB in size for HTTP POST requests. </para> <important>Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, Amazon CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (e.g., NaN, +Infinity, -Infinity) are not supported. </important> <para> Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using <code>GetMetricStatistics</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutMetricData service method.</param> <returns>The response from the PutMetricData service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"> Indicates that the request processing has failed due to some unknown error, exception, or failure. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterCombinationException"> Parameters that must not be used together were used together. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> Bad or out-of-range value was supplied for the input parameter. </exception> <exception cref="T:Amazon.CloudWatch.Model.MissingRequiredParameterException"> An input parameter that is mandatory for processing the request is not supplied. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.PutMetricDataAsync(Amazon.CloudWatch.Model.PutMetricDataRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutMetricData operation. </summary> <param name="request">Container for the necessary parameters to execute the PutMetricData operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.SetAlarmState(Amazon.CloudWatch.Model.SetAlarmStateRequest)"> <summary> Temporarily sets the state of an alarm. When the updated <code>StateValue</code> differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm's state to <b>ALARM</b> will send an Amazon SNS message. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. Because the alarm state change happens very quickly, it is typically only visibile in the alarm's <b>History</b> tab in the Amazon CloudWatch console or through <code>DescribeAlarmHistory</code>. </summary> <param name="request">Container for the necessary parameters to execute the SetAlarmState service method.</param> <returns>The response from the SetAlarmState service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidFormatException"> Data was not syntactically valid JSON. </exception> <exception cref="T:Amazon.CloudWatch.Model.ResourceNotFoundException"> The named resource does not exist. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.SetAlarmStateAsync(Amazon.CloudWatch.Model.SetAlarmStateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetAlarmState operation. </summary> <param name="request">Container for the necessary parameters to execute the SetAlarmState operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor"> <summary> Constructs AmazonCloudWatchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudWatchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(Amazon.CloudWatch.AmazonCloudWatchConfig)"> <summary> Constructs AmazonCloudWatchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudWatchClient Configuration Object</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudWatchClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudWatchClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudWatch.AmazonCloudWatchConfig)"> <summary> Constructs AmazonCloudWatchClient with AWS Credentials and an AmazonCloudWatchClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudWatchClient Configuration Object</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(System.String,System.String,Amazon.CloudWatch.AmazonCloudWatchConfig)"> <summary> Constructs AmazonCloudWatchClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudWatchClient Configuration Object</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(System.String,System.String,System.String,Amazon.CloudWatch.AmazonCloudWatchConfig)"> <summary> Constructs AmazonCloudWatchClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudWatchClient Configuration Object</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DeleteAlarms(Amazon.CloudWatch.Model.DeleteAlarmsRequest)"> <summary> Deletes all specified alarms. In the event of an error, no alarms are deleted. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAlarms service method.</param> <returns>The response from the DeleteAlarms service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.ResourceNotFoundException"> The named resource does not exist. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DeleteAlarmsAsync(Amazon.CloudWatch.Model.DeleteAlarmsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAlarms operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAlarms operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarmHistory"> <summary> Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms. <note> Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. </note> </summary> <returns>The response from the DescribeAlarmHistory service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> The next token specified is invalid. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarmHistory(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest)"> <summary> Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms. <note> Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarmHistory service method.</param> <returns>The response from the DescribeAlarmHistory service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> The next token specified is invalid. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarmHistoryAsync(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAlarmHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarmHistory operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarms"> <summary> Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action. </summary> <returns>The response from the DescribeAlarms service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> The next token specified is invalid. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarms(Amazon.CloudWatch.Model.DescribeAlarmsRequest)"> <summary> Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarms service method.</param> <returns>The response from the DescribeAlarms service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> The next token specified is invalid. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarmsAsync(Amazon.CloudWatch.Model.DescribeAlarmsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAlarms operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarms operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarmsForMetric(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest)"> <summary> Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarmsForMetric service method.</param> <returns>The response from the DescribeAlarmsForMetric service method, as returned by CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarmsForMetricAsync(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAlarmsForMetric operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarmsForMetric operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DisableAlarmActions(Amazon.CloudWatch.Model.DisableAlarmActionsRequest)"> <summary> Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute. </summary> <param name="request">Container for the necessary parameters to execute the DisableAlarmActions service method.</param> <returns>The response from the DisableAlarmActions service method, as returned by CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DisableAlarmActionsAsync(Amazon.CloudWatch.Model.DisableAlarmActionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableAlarmActions operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableAlarmActions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EnableAlarmActions(Amazon.CloudWatch.Model.EnableAlarmActionsRequest)"> <summary> Enables actions for the specified alarms. </summary> <param name="request">Container for the necessary parameters to execute the EnableAlarmActions service method.</param> <returns>The response from the EnableAlarmActions service method, as returned by CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EnableAlarmActionsAsync(Amazon.CloudWatch.Model.EnableAlarmActionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableAlarmActions operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableAlarmActions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.GetMetricStatistics(Amazon.CloudWatch.Model.GetMetricStatisticsRequest)"> <summary> Gets statistics for the specified metric. <para> The maximum number of data points that can be queried is 50,850, whereas the maximum number of data points returned from a single <code>GetMetricStatistics</code> request is 1,440. If you make a request that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, you can alter the request by narrowing the specified time range or increasing the specified period. Alternatively, you can make multiple requests across adjacent time ranges. <code>GetMetricStatistics</code> does not return the data in chronological order. </para> <para> Amazon CloudWatch aggregates data points based on the length of the <code>period</code> that you specify. For example, if you request statistics with a one-minute granularity, Amazon CloudWatch aggregates data points with time stamps that fall within the same one-minute period. In such a case, the data points queried can greatly outnumber the data points returned. </para> <para> The following examples show various statistics allowed by the data point query maximum of 50,850 when you call <code>GetMetricStatistics</code> on Amazon EC2 instances with detailed (one-minute) monitoring enabled: </para> <ul> <li>Statistics for up to 400 instances for a span of one hour</li> <li>Statistics for up to 35 instances over a span of 24 hours</li> <li>Statistics for up to 2 instances over a span of 2 weeks</li> </ul> <para> For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to CloudWatch, go to <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html">Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference</a> in the <i>Amazon CloudWatch Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetMetricStatistics service method.</param> <returns>The response from the GetMetricStatistics service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"> Indicates that the request processing has failed due to some unknown error, exception, or failure. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterCombinationException"> Parameters that must not be used together were used together. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> Bad or out-of-range value was supplied for the input parameter. </exception> <exception cref="T:Amazon.CloudWatch.Model.MissingRequiredParameterException"> An input parameter that is mandatory for processing the request is not supplied. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.GetMetricStatisticsAsync(Amazon.CloudWatch.Model.GetMetricStatisticsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetMetricStatistics operation. </summary> <param name="request">Container for the necessary parameters to execute the GetMetricStatistics operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.ListMetrics"> <summary> Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with <a>GetMetricStatistics</a> to obtain statistical data for a given metric. <note> Up to 500 results are returned for any one call. To retrieve further results, use returned <code>NextToken</code> values with subsequent <code>ListMetrics</code> operations. </note> <note> If you create a metric with the <a>PutMetricData</a> action, allow up to fifteen minutes for the metric to appear in calls to the <code>ListMetrics</code> action. Statistics about the metric, however, are available sooner using <a>GetMetricStatistics</a>. </note> </summary> <returns>The response from the ListMetrics service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"> Indicates that the request processing has failed due to some unknown error, exception, or failure. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> Bad or out-of-range value was supplied for the input parameter. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.ListMetrics(Amazon.CloudWatch.Model.ListMetricsRequest)"> <summary> Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with <a>GetMetricStatistics</a> to obtain statistical data for a given metric. <note> Up to 500 results are returned for any one call. To retrieve further results, use returned <code>NextToken</code> values with subsequent <code>ListMetrics</code> operations. </note> <note> If you create a metric with the <a>PutMetricData</a> action, allow up to fifteen minutes for the metric to appear in calls to the <code>ListMetrics</code> action. Statistics about the metric, however, are available sooner using <a>GetMetricStatistics</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the ListMetrics service method.</param> <returns>The response from the ListMetrics service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"> Indicates that the request processing has failed due to some unknown error, exception, or failure. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> Bad or out-of-range value was supplied for the input parameter. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.ListMetricsAsync(Amazon.CloudWatch.Model.ListMetricsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListMetrics operation. </summary> <param name="request">Container for the necessary parameters to execute the ListMetrics operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.PutMetricAlarm(Amazon.CloudWatch.Model.PutMetricAlarmRequest)"> <summary> Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm. <para> When this operation creates an alarm, the alarm state is immediately set to <code>INSUFFICIENT_DATA</code>. The alarm is evaluated and its <code>StateValue</code> is set appropriately. Any actions associated with the <code>StateValue</code> is then executed. </para> <note> When updating an existing alarm, its <code>StateValue</code> is left unchanged. </note> <note> If you are using an AWS Identity and Access Management (IAM) account to create or modify an alarm, you must have the following Amazon EC2 permissions: <ul> <li><code>ec2:DescribeInstanceStatus</code> and <code>ec2:DescribeInstances</code> for all alarms on Amazon EC2 instance status metrics.</li> <li><code>ec2:StopInstances</code> for alarms with stop actions.</li> <li><code>ec2:TerminateInstances</code> for alarms with terminate actions.</li> <li><code>ec2:DescribeInstanceRecoveryAttribute</code>, and <code>ec2:RecoverInstances</code> for alarms with recover actions.</li> </ul> <para> If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm but the stop or terminate actions won't be performed on the Amazon EC2 instance. However, if you are later granted permission to use the associated Amazon EC2 APIs, the alarm actions you created earlier will be performed. For more information about IAM permissions, see <a href="http://docs.aws.amazon.com//IAM/latest/UserGuide/PermissionsAndPolicies.html">Permissions and Policies</a> in <i>Using IAM</i>. </para> <para> If you are using an IAM role (e.g., an Amazon EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies. </para> <para> If you are using temporary security credentials granted using the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the PutMetricAlarm service method.</param> <returns>The response from the PutMetricAlarm service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.LimitExceededException"> The quota for alarms for this customer has already been reached. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.PutMetricAlarmAsync(Amazon.CloudWatch.Model.PutMetricAlarmRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutMetricAlarm operation. </summary> <param name="request">Container for the necessary parameters to execute the PutMetricAlarm operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.PutMetricData(Amazon.CloudWatch.Model.PutMetricDataRequest)"> <summary> Publishes metric data points to Amazon CloudWatch. Amazon CloudWatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric. When Amazon CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to the <a>ListMetrics</a> action. <para> Each <code>PutMetricData</code> request is limited to 8 KB in size for HTTP GET requests and is limited to 40 KB in size for HTTP POST requests. </para> <important>Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, Amazon CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (e.g., NaN, +Infinity, -Infinity) are not supported. </important> <para> Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using <code>GetMetricStatistics</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutMetricData service method.</param> <returns>The response from the PutMetricData service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"> Indicates that the request processing has failed due to some unknown error, exception, or failure. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterCombinationException"> Parameters that must not be used together were used together. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> Bad or out-of-range value was supplied for the input parameter. </exception> <exception cref="T:Amazon.CloudWatch.Model.MissingRequiredParameterException"> An input parameter that is mandatory for processing the request is not supplied. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.PutMetricDataAsync(Amazon.CloudWatch.Model.PutMetricDataRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutMetricData operation. </summary> <param name="request">Container for the necessary parameters to execute the PutMetricData operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.SetAlarmState(Amazon.CloudWatch.Model.SetAlarmStateRequest)"> <summary> Temporarily sets the state of an alarm. When the updated <code>StateValue</code> differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm's state to <b>ALARM</b> will send an Amazon SNS message. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. Because the alarm state change happens very quickly, it is typically only visibile in the alarm's <b>History</b> tab in the Amazon CloudWatch console or through <code>DescribeAlarmHistory</code>. </summary> <param name="request">Container for the necessary parameters to execute the SetAlarmState service method.</param> <returns>The response from the SetAlarmState service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidFormatException"> Data was not syntactically valid JSON. </exception> <exception cref="T:Amazon.CloudWatch.Model.ResourceNotFoundException"> The named resource does not exist. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.SetAlarmStateAsync(Amazon.CloudWatch.Model.SetAlarmStateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetAlarmState operation. </summary> <param name="request">Container for the necessary parameters to execute the SetAlarmState operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.DataPipeline.AmazonDataPipelineClient"> <summary> Implementation for accessing DataPipeline AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so that your application can focus on processing the data. <para> AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management. </para> <para> AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data. Use the second set in your task runner application to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service. </para> </summary> </member> <member name="T:Amazon.DataPipeline.IAmazonDataPipeline"> <summary> Interface for accessing DataPipeline AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so that your application can focus on processing the data. <para> AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management. </para> <para> AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data. Use the second set in your task runner application to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service. </para> </summary> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ActivatePipeline(Amazon.DataPipeline.Model.ActivatePipelineRequest)"> <summary> Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails. <para> If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call <a>DeactivatePipeline</a>. </para> <para> To activate a finished pipeline, modify the end date for the pipeline and then activate it. </para> </summary> <param name="request">Container for the necessary parameters to execute the ActivatePipeline service method.</param> <returns>The response from the ActivatePipeline service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ActivatePipelineAsync(Amazon.DataPipeline.Model.ActivatePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ActivatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the ActivatePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.AddTags(System.String,System.Collections.Generic.List{Amazon.DataPipeline.Model.Tag})"> <summary> Adds or modifies tags for the specified pipeline. </summary> <param name="pipelineId">The ID of the pipeline.</param> <param name="tags">The tags to add, as key/value pairs.</param> <returns>The response from the AddTags service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.AddTags(Amazon.DataPipeline.Model.AddTagsRequest)"> <summary> Adds or modifies tags for the specified pipeline. </summary> <param name="request">Container for the necessary parameters to execute the AddTags service method.</param> <returns>The response from the AddTags service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.AddTagsAsync(Amazon.DataPipeline.Model.AddTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTags operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.CreatePipeline(Amazon.DataPipeline.Model.CreatePipelineRequest)"> <summary> Creates a new, empty pipeline. Use <a>PutPipelineDefinition</a> to populate the pipeline. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline service method.</param> <returns>The response from the CreatePipeline service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.CreatePipelineAsync(Amazon.DataPipeline.Model.CreatePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.DeactivatePipeline(Amazon.DataPipeline.Model.DeactivatePipelineRequest)"> <summary> Deactivates the specified running pipeline. The pipeline is set to the <code>DEACTIVATING</code> state until the deactivation process completes. <para> To resume a deactivated pipeline, use <a>ActivatePipeline</a>. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeactivatePipeline service method.</param> <returns>The response from the DeactivatePipeline service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.DeactivatePipelineAsync(Amazon.DataPipeline.Model.DeactivatePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeactivatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the DeactivatePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.DeletePipeline(Amazon.DataPipeline.Model.DeletePipelineRequest)"> <summary> Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners. <para> Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call <a>SetStatus</a> with the status set to <code>PAUSE</code> on individual components. Components that are paused by <a>SetStatus</a> can be resumed. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline service method.</param> <returns>The response from the DeletePipeline service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.DeletePipelineAsync(Amazon.DataPipeline.Model.DeletePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.DescribeObjects(Amazon.DataPipeline.Model.DescribeObjectsRequest)"> <summary> Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object. </summary> <param name="request">Container for the necessary parameters to execute the DescribeObjects service method.</param> <returns>The response from the DescribeObjects service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.DescribeObjectsAsync(Amazon.DataPipeline.Model.DescribeObjectsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeObjects operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeObjects operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.DescribePipelines(System.Collections.Generic.List{System.String})"> <summary> Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions. <para> To retrieve the full pipeline definition instead of metadata about the pipeline, call <a>GetPipelineDefinition</a>. </para> </summary> <param name="pipelineIds">The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call <a>ListPipelines</a>.</param> <returns>The response from the DescribePipelines service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.DescribePipelines(Amazon.DataPipeline.Model.DescribePipelinesRequest)"> <summary> Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions. <para> To retrieve the full pipeline definition instead of metadata about the pipeline, call <a>GetPipelineDefinition</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribePipelines service method.</param> <returns>The response from the DescribePipelines service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.DescribePipelinesAsync(Amazon.DataPipeline.Model.DescribePipelinesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribePipelines operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePipelines operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.EvaluateExpression(Amazon.DataPipeline.Model.EvaluateExpressionRequest)"> <summary> Task runners call <code>EvaluateExpression</code> to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3. </summary> <param name="request">Container for the necessary parameters to execute the EvaluateExpression service method.</param> <returns>The response from the EvaluateExpression service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"> The specified task was not found. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.EvaluateExpressionAsync(Amazon.DataPipeline.Model.EvaluateExpressionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EvaluateExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the EvaluateExpression operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.GetPipelineDefinition(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest)"> <summary> Gets the definition of the specified pipeline. You can call <code>GetPipelineDefinition</code> to retrieve the pipeline definition that you provided using <a>PutPipelineDefinition</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetPipelineDefinition service method.</param> <returns>The response from the GetPipelineDefinition service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.GetPipelineDefinitionAsync(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetPipelineDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPipelineDefinition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ListPipelines"> <summary> Lists the pipeline identifiers for all active pipelines that you have permission to access. </summary> <returns>The response from the ListPipelines service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ListPipelines(Amazon.DataPipeline.Model.ListPipelinesRequest)"> <summary> Lists the pipeline identifiers for all active pipelines that you have permission to access. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines service method.</param> <returns>The response from the ListPipelines service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ListPipelinesAsync(Amazon.DataPipeline.Model.ListPipelinesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListPipelines operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.PollForTask(Amazon.DataPipeline.Model.PollForTaskRequest)"> <summary> Task runners call <code>PollForTask</code> to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the <code>workerGroup</code> parameter. The task returned can come from any of the pipelines that match the <code>workerGroup</code> value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner. <para> If tasks are ready in the work queue, <code>PollForTask</code> returns a response immediately. If no tasks are available in the queue, <code>PollForTask</code> uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call <code>PollForTask</code> again on the same <code>workerGroup</code> until it receives a response, and this can take up to 90 seconds. </para> </summary> <param name="request">Container for the necessary parameters to execute the PollForTask service method.</param> <returns>The response from the PollForTask service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"> The specified task was not found. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.PollForTaskAsync(Amazon.DataPipeline.Model.PollForTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PollForTask operation. </summary> <param name="request">Container for the necessary parameters to execute the PollForTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.PutPipelineDefinition(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest)"> <summary> Adds tasks, schedules, and preconditions to the specified pipeline. You can use <code>PutPipelineDefinition</code> to populate a new pipeline. <para> <code>PutPipelineDefinition</code> also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline. </para> <ol> <li>An object is missing a name or identifier field.</li> <li>A string or reference field is empty.</li> <li>The number of objects in the pipeline exceeds the maximum allowed objects.</li> <li>The pipeline is in a FINISHED state.</li> </ol> <para> Pipeline object definitions are passed to the <code>PutPipelineDefinition</code> action and returned by the <a>GetPipelineDefinition</a> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutPipelineDefinition service method.</param> <returns>The response from the PutPipelineDefinition service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.PutPipelineDefinitionAsync(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutPipelineDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the PutPipelineDefinition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.QueryObjects(Amazon.DataPipeline.Model.QueryObjectsRequest)"> <summary> Queries the specified pipeline for the names of objects that match the specified set of conditions. </summary> <param name="request">Container for the necessary parameters to execute the QueryObjects service method.</param> <returns>The response from the QueryObjects service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.QueryObjectsAsync(Amazon.DataPipeline.Model.QueryObjectsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the QueryObjects operation. </summary> <param name="request">Container for the necessary parameters to execute the QueryObjects operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.RemoveTags(System.String,System.Collections.Generic.List{System.String})"> <summary> Removes existing tags from the specified pipeline. </summary> <param name="pipelineId">The ID of the pipeline.</param> <param name="tagKeys">The keys of the tags to remove.</param> <returns>The response from the RemoveTags service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.RemoveTags(Amazon.DataPipeline.Model.RemoveTagsRequest)"> <summary> Removes existing tags from the specified pipeline. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags service method.</param> <returns>The response from the RemoveTags service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.RemoveTagsAsync(Amazon.DataPipeline.Model.RemoveTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTags operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ReportTaskProgress(Amazon.DataPipeline.Model.ReportTaskProgressRequest)"> <summary> Task runners call <code>ReportTaskProgress</code> when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent <a>PollForTask</a> call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a <code>reportProgressTimeout</code> field in your pipeline. <para> If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to <a>PollForTask</a>. Task runners should call <code>ReportTaskProgress</code> every 60 seconds. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReportTaskProgress service method.</param> <returns>The response from the ReportTaskProgress service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"> The specified task was not found. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ReportTaskProgressAsync(Amazon.DataPipeline.Model.ReportTaskProgressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReportTaskProgress operation. </summary> <param name="request">Container for the necessary parameters to execute the ReportTaskProgress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ReportTaskRunnerHeartbeat(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest)"> <summary> Task runners call <code>ReportTaskRunnerHeartbeat</code> every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance. </summary> <param name="request">Container for the necessary parameters to execute the ReportTaskRunnerHeartbeat service method.</param> <returns>The response from the ReportTaskRunnerHeartbeat service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ReportTaskRunnerHeartbeatAsync(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReportTaskRunnerHeartbeat operation. </summary> <param name="request">Container for the necessary parameters to execute the ReportTaskRunnerHeartbeat operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.SetStatus(Amazon.DataPipeline.Model.SetStatusRequest)"> <summary> Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on <code>FINISHED</code> pipelines and attempting to do so returns <code>InvalidRequestException</code>. </summary> <param name="request">Container for the necessary parameters to execute the SetStatus service method.</param> <returns>The response from the SetStatus service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.SetStatusAsync(Amazon.DataPipeline.Model.SetStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the SetStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.SetTaskStatus(Amazon.DataPipeline.Model.SetTaskStatusRequest)"> <summary> Task runners call <code>SetTaskStatus</code> to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call <code>SetTaskStatus</code> for tasks that are canceled by the web service during a call to <a>ReportTaskProgress</a>. </summary> <param name="request">Container for the necessary parameters to execute the SetTaskStatus service method.</param> <returns>The response from the SetTaskStatus service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"> The specified task was not found. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.SetTaskStatusAsync(Amazon.DataPipeline.Model.SetTaskStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetTaskStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the SetTaskStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ValidatePipelineDefinition(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest)"> <summary> Validates the specified pipeline definition to ensure that it is well formed and can be run without error. </summary> <param name="request">Container for the necessary parameters to execute the ValidatePipelineDefinition service method.</param> <returns>The response from the ValidatePipelineDefinition service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ValidatePipelineDefinitionAsync(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ValidatePipelineDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the ValidatePipelineDefinition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor"> <summary> Constructs AmazonDataPipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonDataPipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(Amazon.DataPipeline.AmazonDataPipelineConfig)"> <summary> Constructs AmazonDataPipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonDataPipelineClient Configuration Object</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonDataPipelineClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDataPipelineClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.DataPipeline.AmazonDataPipelineConfig)"> <summary> Constructs AmazonDataPipelineClient with AWS Credentials and an AmazonDataPipelineClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonDataPipelineClient Configuration Object</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonDataPipelineClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDataPipelineClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(System.String,System.String,Amazon.DataPipeline.AmazonDataPipelineConfig)"> <summary> Constructs AmazonDataPipelineClient with AWS Access Key ID, AWS Secret Key and an AmazonDataPipelineClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonDataPipelineClient Configuration Object</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonDataPipelineClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDataPipelineClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(System.String,System.String,System.String,Amazon.DataPipeline.AmazonDataPipelineConfig)"> <summary> Constructs AmazonDataPipelineClient with AWS Access Key ID, AWS Secret Key and an AmazonDataPipelineClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonDataPipelineClient Configuration Object</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ActivatePipeline(Amazon.DataPipeline.Model.ActivatePipelineRequest)"> <summary> Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails. <para> If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call <a>DeactivatePipeline</a>. </para> <para> To activate a finished pipeline, modify the end date for the pipeline and then activate it. </para> </summary> <param name="request">Container for the necessary parameters to execute the ActivatePipeline service method.</param> <returns>The response from the ActivatePipeline service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ActivatePipelineAsync(Amazon.DataPipeline.Model.ActivatePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ActivatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the ActivatePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.AddTags(System.String,System.Collections.Generic.List{Amazon.DataPipeline.Model.Tag})"> <summary> Adds or modifies tags for the specified pipeline. </summary> <param name="pipelineId">The ID of the pipeline.</param> <param name="tags">The tags to add, as key/value pairs.</param> <returns>The response from the AddTags service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.AddTags(Amazon.DataPipeline.Model.AddTagsRequest)"> <summary> Adds or modifies tags for the specified pipeline. </summary> <param name="request">Container for the necessary parameters to execute the AddTags service method.</param> <returns>The response from the AddTags service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.AddTagsAsync(Amazon.DataPipeline.Model.AddTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTags operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.CreatePipeline(Amazon.DataPipeline.Model.CreatePipelineRequest)"> <summary> Creates a new, empty pipeline. Use <a>PutPipelineDefinition</a> to populate the pipeline. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline service method.</param> <returns>The response from the CreatePipeline service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.CreatePipelineAsync(Amazon.DataPipeline.Model.CreatePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DeactivatePipeline(Amazon.DataPipeline.Model.DeactivatePipelineRequest)"> <summary> Deactivates the specified running pipeline. The pipeline is set to the <code>DEACTIVATING</code> state until the deactivation process completes. <para> To resume a deactivated pipeline, use <a>ActivatePipeline</a>. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeactivatePipeline service method.</param> <returns>The response from the DeactivatePipeline service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DeactivatePipelineAsync(Amazon.DataPipeline.Model.DeactivatePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeactivatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the DeactivatePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DeletePipeline(Amazon.DataPipeline.Model.DeletePipelineRequest)"> <summary> Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners. <para> Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call <a>SetStatus</a> with the status set to <code>PAUSE</code> on individual components. Components that are paused by <a>SetStatus</a> can be resumed. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline service method.</param> <returns>The response from the DeletePipeline service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DeletePipelineAsync(Amazon.DataPipeline.Model.DeletePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DescribeObjects(Amazon.DataPipeline.Model.DescribeObjectsRequest)"> <summary> Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object. </summary> <param name="request">Container for the necessary parameters to execute the DescribeObjects service method.</param> <returns>The response from the DescribeObjects service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DescribeObjectsAsync(Amazon.DataPipeline.Model.DescribeObjectsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeObjects operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeObjects operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DescribePipelines(System.Collections.Generic.List{System.String})"> <summary> Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions. <para> To retrieve the full pipeline definition instead of metadata about the pipeline, call <a>GetPipelineDefinition</a>. </para> </summary> <param name="pipelineIds">The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call <a>ListPipelines</a>.</param> <returns>The response from the DescribePipelines service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DescribePipelines(Amazon.DataPipeline.Model.DescribePipelinesRequest)"> <summary> Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions. <para> To retrieve the full pipeline definition instead of metadata about the pipeline, call <a>GetPipelineDefinition</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribePipelines service method.</param> <returns>The response from the DescribePipelines service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DescribePipelinesAsync(Amazon.DataPipeline.Model.DescribePipelinesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribePipelines operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePipelines operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EvaluateExpression(Amazon.DataPipeline.Model.EvaluateExpressionRequest)"> <summary> Task runners call <code>EvaluateExpression</code> to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3. </summary> <param name="request">Container for the necessary parameters to execute the EvaluateExpression service method.</param> <returns>The response from the EvaluateExpression service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"> The specified task was not found. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EvaluateExpressionAsync(Amazon.DataPipeline.Model.EvaluateExpressionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EvaluateExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the EvaluateExpression operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.GetPipelineDefinition(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest)"> <summary> Gets the definition of the specified pipeline. You can call <code>GetPipelineDefinition</code> to retrieve the pipeline definition that you provided using <a>PutPipelineDefinition</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetPipelineDefinition service method.</param> <returns>The response from the GetPipelineDefinition service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.GetPipelineDefinitionAsync(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetPipelineDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPipelineDefinition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ListPipelines"> <summary> Lists the pipeline identifiers for all active pipelines that you have permission to access. </summary> <returns>The response from the ListPipelines service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ListPipelines(Amazon.DataPipeline.Model.ListPipelinesRequest)"> <summary> Lists the pipeline identifiers for all active pipelines that you have permission to access. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines service method.</param> <returns>The response from the ListPipelines service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ListPipelinesAsync(Amazon.DataPipeline.Model.ListPipelinesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListPipelines operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.PollForTask(Amazon.DataPipeline.Model.PollForTaskRequest)"> <summary> Task runners call <code>PollForTask</code> to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the <code>workerGroup</code> parameter. The task returned can come from any of the pipelines that match the <code>workerGroup</code> value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner. <para> If tasks are ready in the work queue, <code>PollForTask</code> returns a response immediately. If no tasks are available in the queue, <code>PollForTask</code> uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call <code>PollForTask</code> again on the same <code>workerGroup</code> until it receives a response, and this can take up to 90 seconds. </para> </summary> <param name="request">Container for the necessary parameters to execute the PollForTask service method.</param> <returns>The response from the PollForTask service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"> The specified task was not found. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.PollForTaskAsync(Amazon.DataPipeline.Model.PollForTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PollForTask operation. </summary> <param name="request">Container for the necessary parameters to execute the PollForTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.PutPipelineDefinition(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest)"> <summary> Adds tasks, schedules, and preconditions to the specified pipeline. You can use <code>PutPipelineDefinition</code> to populate a new pipeline. <para> <code>PutPipelineDefinition</code> also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline. </para> <ol> <li>An object is missing a name or identifier field.</li> <li>A string or reference field is empty.</li> <li>The number of objects in the pipeline exceeds the maximum allowed objects.</li> <li>The pipeline is in a FINISHED state.</li> </ol> <para> Pipeline object definitions are passed to the <code>PutPipelineDefinition</code> action and returned by the <a>GetPipelineDefinition</a> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutPipelineDefinition service method.</param> <returns>The response from the PutPipelineDefinition service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.PutPipelineDefinitionAsync(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutPipelineDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the PutPipelineDefinition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.QueryObjects(Amazon.DataPipeline.Model.QueryObjectsRequest)"> <summary> Queries the specified pipeline for the names of objects that match the specified set of conditions. </summary> <param name="request">Container for the necessary parameters to execute the QueryObjects service method.</param> <returns>The response from the QueryObjects service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.QueryObjectsAsync(Amazon.DataPipeline.Model.QueryObjectsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the QueryObjects operation. </summary> <param name="request">Container for the necessary parameters to execute the QueryObjects operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.RemoveTags(System.String,System.Collections.Generic.List{System.String})"> <summary> Removes existing tags from the specified pipeline. </summary> <param name="pipelineId">The ID of the pipeline.</param> <param name="tagKeys">The keys of the tags to remove.</param> <returns>The response from the RemoveTags service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.RemoveTags(Amazon.DataPipeline.Model.RemoveTagsRequest)"> <summary> Removes existing tags from the specified pipeline. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags service method.</param> <returns>The response from the RemoveTags service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.RemoveTagsAsync(Amazon.DataPipeline.Model.RemoveTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTags operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ReportTaskProgress(Amazon.DataPipeline.Model.ReportTaskProgressRequest)"> <summary> Task runners call <code>ReportTaskProgress</code> when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent <a>PollForTask</a> call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a <code>reportProgressTimeout</code> field in your pipeline. <para> If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to <a>PollForTask</a>. Task runners should call <code>ReportTaskProgress</code> every 60 seconds. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReportTaskProgress service method.</param> <returns>The response from the ReportTaskProgress service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"> The specified task was not found. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ReportTaskProgressAsync(Amazon.DataPipeline.Model.ReportTaskProgressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReportTaskProgress operation. </summary> <param name="request">Container for the necessary parameters to execute the ReportTaskProgress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ReportTaskRunnerHeartbeat(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest)"> <summary> Task runners call <code>ReportTaskRunnerHeartbeat</code> every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance. </summary> <param name="request">Container for the necessary parameters to execute the ReportTaskRunnerHeartbeat service method.</param> <returns>The response from the ReportTaskRunnerHeartbeat service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ReportTaskRunnerHeartbeatAsync(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReportTaskRunnerHeartbeat operation. </summary> <param name="request">Container for the necessary parameters to execute the ReportTaskRunnerHeartbeat operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.SetStatus(Amazon.DataPipeline.Model.SetStatusRequest)"> <summary> Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on <code>FINISHED</code> pipelines and attempting to do so returns <code>InvalidRequestException</code>. </summary> <param name="request">Container for the necessary parameters to execute the SetStatus service method.</param> <returns>The response from the SetStatus service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.SetStatusAsync(Amazon.DataPipeline.Model.SetStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the SetStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.SetTaskStatus(Amazon.DataPipeline.Model.SetTaskStatusRequest)"> <summary> Task runners call <code>SetTaskStatus</code> to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call <code>SetTaskStatus</code> for tasks that are canceled by the web service during a call to <a>ReportTaskProgress</a>. </summary> <param name="request">Container for the necessary parameters to execute the SetTaskStatus service method.</param> <returns>The response from the SetTaskStatus service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"> The specified task was not found. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.SetTaskStatusAsync(Amazon.DataPipeline.Model.SetTaskStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetTaskStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the SetTaskStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ValidatePipelineDefinition(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest)"> <summary> Validates the specified pipeline definition to ensure that it is well formed and can be run without error. </summary> <param name="request">Container for the necessary parameters to execute the ValidatePipelineDefinition service method.</param> <returns>The response from the ValidatePipelineDefinition service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ValidatePipelineDefinitionAsync(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ValidatePipelineDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the ValidatePipelineDefinition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.DeviceFarm.AmazonDeviceFarmClient"> <summary> Implementation for accessing DeviceFarm AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud. </summary> </member> <member name="T:Amazon.DeviceFarm.IAmazonDeviceFarm"> <summary> Interface for accessing DeviceFarm AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud. </summary> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.CreateDevicePool(Amazon.DeviceFarm.Model.CreateDevicePoolRequest)"> <summary> Creates a device pool. </summary> <param name="request">Container for the necessary parameters to execute the CreateDevicePool service method.</param> <returns>The response from the CreateDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.CreateDevicePoolAsync(Amazon.DeviceFarm.Model.CreateDevicePoolRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDevicePool operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDevicePool operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.CreateProject(System.String)"> <summary> Creates a new project. </summary> <param name="name">The project's name.</param> <returns>The response from the CreateProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.CreateProject(Amazon.DeviceFarm.Model.CreateProjectRequest)"> <summary> Creates a new project. </summary> <param name="request">Container for the necessary parameters to execute the CreateProject service method.</param> <returns>The response from the CreateProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.CreateProjectAsync(Amazon.DeviceFarm.Model.CreateProjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateProject operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateProject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.CreateUpload(Amazon.DeviceFarm.Model.CreateUploadRequest)"> <summary> Uploads an app or test scripts. </summary> <param name="request">Container for the necessary parameters to execute the CreateUpload service method.</param> <returns>The response from the CreateUpload service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.CreateUploadAsync(Amazon.DeviceFarm.Model.CreateUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.DeleteDevicePool(Amazon.DeviceFarm.Model.DeleteDevicePoolRequest)"> <summary> Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDevicePool service method.</param> <returns>The response from the DeleteDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.DeleteDevicePoolAsync(Amazon.DeviceFarm.Model.DeleteDevicePoolRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDevicePool operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDevicePool operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.DeleteProject(Amazon.DeviceFarm.Model.DeleteProjectRequest)"> <summary> Deletes an AWS Device Farm project, given the project ARN. <para> <b>Note</b> Deleting this resource does not stop an in-progress run. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteProject service method.</param> <returns>The response from the DeleteProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.DeleteProjectAsync(Amazon.DeviceFarm.Model.DeleteProjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteProject operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteProject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.DeleteRun(Amazon.DeviceFarm.Model.DeleteRunRequest)"> <summary> Deletes the run, given the run ARN. <para> <b>Note</b> Deleting this resource does not stop an in-progress run. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteRun service method.</param> <returns>The response from the DeleteRun service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.DeleteRunAsync(Amazon.DeviceFarm.Model.DeleteRunRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRun operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRun operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.DeleteUpload(Amazon.DeviceFarm.Model.DeleteUploadRequest)"> <summary> Deletes an upload given the upload ARN. </summary> <param name="request">Container for the necessary parameters to execute the DeleteUpload service method.</param> <returns>The response from the DeleteUpload service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.DeleteUploadAsync(Amazon.DeviceFarm.Model.DeleteUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetAccountSettings"> <summary> Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account. </summary> <returns>The response from the GetAccountSettings service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetAccountSettings(Amazon.DeviceFarm.Model.GetAccountSettingsRequest)"> <summary> Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account. </summary> <param name="request">Container for the necessary parameters to execute the GetAccountSettings service method.</param> <returns>The response from the GetAccountSettings service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetAccountSettingsAsync(Amazon.DeviceFarm.Model.GetAccountSettingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetAccountSettings operation. </summary> <param name="request">Container for the necessary parameters to execute the GetAccountSettings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetDevice(System.String)"> <summary> Gets information about a unique device type. </summary> <param name="arn">The device type's ARN.</param> <returns>The response from the GetDevice service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetDevice(Amazon.DeviceFarm.Model.GetDeviceRequest)"> <summary> Gets information about a unique device type. </summary> <param name="request">Container for the necessary parameters to execute the GetDevice service method.</param> <returns>The response from the GetDevice service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetDeviceAsync(Amazon.DeviceFarm.Model.GetDeviceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDevice operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDevice operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetDevicePool(System.String)"> <summary> Gets information about a device pool. </summary> <param name="arn">The device pool's ARN.</param> <returns>The response from the GetDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetDevicePool(Amazon.DeviceFarm.Model.GetDevicePoolRequest)"> <summary> Gets information about a device pool. </summary> <param name="request">Container for the necessary parameters to execute the GetDevicePool service method.</param> <returns>The response from the GetDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetDevicePoolAsync(Amazon.DeviceFarm.Model.GetDevicePoolRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDevicePool operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDevicePool operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetDevicePoolCompatibility(Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityRequest)"> <summary> Gets information about compatibility with a device pool. </summary> <param name="request">Container for the necessary parameters to execute the GetDevicePoolCompatibility service method.</param> <returns>The response from the GetDevicePoolCompatibility service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetDevicePoolCompatibilityAsync(Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDevicePoolCompatibility operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDevicePoolCompatibility operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetJob(System.String)"> <summary> Gets information about a job. </summary> <param name="arn">The job's ARN.</param> <returns>The response from the GetJob service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetJob(Amazon.DeviceFarm.Model.GetJobRequest)"> <summary> Gets information about a job. </summary> <param name="request">Container for the necessary parameters to execute the GetJob service method.</param> <returns>The response from the GetJob service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetJobAsync(Amazon.DeviceFarm.Model.GetJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetJob operation. </summary> <param name="request">Container for the necessary parameters to execute the GetJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetProject(System.String)"> <summary> Gets information about a project. </summary> <param name="arn">The project's ARN.</param> <returns>The response from the GetProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetProject(Amazon.DeviceFarm.Model.GetProjectRequest)"> <summary> Gets information about a project. </summary> <param name="request">Container for the necessary parameters to execute the GetProject service method.</param> <returns>The response from the GetProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetProjectAsync(Amazon.DeviceFarm.Model.GetProjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetProject operation. </summary> <param name="request">Container for the necessary parameters to execute the GetProject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetRun(System.String)"> <summary> Gets information about a run. </summary> <param name="arn">The run's ARN.</param> <returns>The response from the GetRun service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetRun(Amazon.DeviceFarm.Model.GetRunRequest)"> <summary> Gets information about a run. </summary> <param name="request">Container for the necessary parameters to execute the GetRun service method.</param> <returns>The response from the GetRun service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetRunAsync(Amazon.DeviceFarm.Model.GetRunRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetRun operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRun operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetSuite(System.String)"> <summary> Gets information about a suite. </summary> <param name="arn">The suite's ARN.</param> <returns>The response from the GetSuite service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetSuite(Amazon.DeviceFarm.Model.GetSuiteRequest)"> <summary> Gets information about a suite. </summary> <param name="request">Container for the necessary parameters to execute the GetSuite service method.</param> <returns>The response from the GetSuite service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetSuiteAsync(Amazon.DeviceFarm.Model.GetSuiteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSuite operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSuite operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetTest(System.String)"> <summary> Gets information about a test. </summary> <param name="arn">The test's ARN.</param> <returns>The response from the GetTest service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetTest(Amazon.DeviceFarm.Model.GetTestRequest)"> <summary> Gets information about a test. </summary> <param name="request">Container for the necessary parameters to execute the GetTest service method.</param> <returns>The response from the GetTest service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetTestAsync(Amazon.DeviceFarm.Model.GetTestRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetTest operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTest operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetUpload(System.String)"> <summary> Gets information about an upload. </summary> <param name="arn">The upload's ARN.</param> <returns>The response from the GetUpload service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetUpload(Amazon.DeviceFarm.Model.GetUploadRequest)"> <summary> Gets information about an upload. </summary> <param name="request">Container for the necessary parameters to execute the GetUpload service method.</param> <returns>The response from the GetUpload service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetUploadAsync(Amazon.DeviceFarm.Model.GetUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the GetUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListArtifacts(Amazon.DeviceFarm.Model.ListArtifactsRequest)"> <summary> Gets information about artifacts. </summary> <param name="request">Container for the necessary parameters to execute the ListArtifacts service method.</param> <returns>The response from the ListArtifacts service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListArtifactsAsync(Amazon.DeviceFarm.Model.ListArtifactsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListArtifacts operation. </summary> <param name="request">Container for the necessary parameters to execute the ListArtifacts operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListDevicePools(Amazon.DeviceFarm.Model.ListDevicePoolsRequest)"> <summary> Gets information about device pools. </summary> <param name="request">Container for the necessary parameters to execute the ListDevicePools service method.</param> <returns>The response from the ListDevicePools service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListDevicePoolsAsync(Amazon.DeviceFarm.Model.ListDevicePoolsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDevicePools operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDevicePools operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListDevices(Amazon.DeviceFarm.Model.ListDevicesRequest)"> <summary> Gets information about unique device types. </summary> <param name="request">Container for the necessary parameters to execute the ListDevices service method.</param> <returns>The response from the ListDevices service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListDevicesAsync(Amazon.DeviceFarm.Model.ListDevicesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDevices operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDevices operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListJobs(Amazon.DeviceFarm.Model.ListJobsRequest)"> <summary> Gets information about jobs. </summary> <param name="request">Container for the necessary parameters to execute the ListJobs service method.</param> <returns>The response from the ListJobs service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListJobsAsync(Amazon.DeviceFarm.Model.ListJobsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListJobs operation. </summary> <param name="request">Container for the necessary parameters to execute the ListJobs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListProjects(Amazon.DeviceFarm.Model.ListProjectsRequest)"> <summary> Gets information about projects. </summary> <param name="request">Container for the necessary parameters to execute the ListProjects service method.</param> <returns>The response from the ListProjects service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListProjectsAsync(Amazon.DeviceFarm.Model.ListProjectsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListProjects operation. </summary> <param name="request">Container for the necessary parameters to execute the ListProjects operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListRuns(Amazon.DeviceFarm.Model.ListRunsRequest)"> <summary> Gets information about runs. </summary> <param name="request">Container for the necessary parameters to execute the ListRuns service method.</param> <returns>The response from the ListRuns service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListRunsAsync(Amazon.DeviceFarm.Model.ListRunsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListRuns operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRuns operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListSamples(Amazon.DeviceFarm.Model.ListSamplesRequest)"> <summary> Gets information about samples. </summary> <param name="request">Container for the necessary parameters to execute the ListSamples service method.</param> <returns>The response from the ListSamples service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListSamplesAsync(Amazon.DeviceFarm.Model.ListSamplesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListSamples operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSamples operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListSuites(Amazon.DeviceFarm.Model.ListSuitesRequest)"> <summary> Gets information about suites. </summary> <param name="request">Container for the necessary parameters to execute the ListSuites service method.</param> <returns>The response from the ListSuites service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListSuitesAsync(Amazon.DeviceFarm.Model.ListSuitesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListSuites operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSuites operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListTests(Amazon.DeviceFarm.Model.ListTestsRequest)"> <summary> Gets information about tests. </summary> <param name="request">Container for the necessary parameters to execute the ListTests service method.</param> <returns>The response from the ListTests service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListTestsAsync(Amazon.DeviceFarm.Model.ListTestsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTests operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTests operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListUniqueProblems(Amazon.DeviceFarm.Model.ListUniqueProblemsRequest)"> <summary> Gets information about unique problems. </summary> <param name="request">Container for the necessary parameters to execute the ListUniqueProblems service method.</param> <returns>The response from the ListUniqueProblems service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListUniqueProblemsAsync(Amazon.DeviceFarm.Model.ListUniqueProblemsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListUniqueProblems operation. </summary> <param name="request">Container for the necessary parameters to execute the ListUniqueProblems operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListUploads(Amazon.DeviceFarm.Model.ListUploadsRequest)"> <summary> Gets information about uploads. </summary> <param name="request">Container for the necessary parameters to execute the ListUploads service method.</param> <returns>The response from the ListUploads service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListUploadsAsync(Amazon.DeviceFarm.Model.ListUploadsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListUploads operation. </summary> <param name="request">Container for the necessary parameters to execute the ListUploads operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ScheduleRun(Amazon.DeviceFarm.Model.ScheduleRunRequest)"> <summary> Schedules a run. </summary> <param name="request">Container for the necessary parameters to execute the ScheduleRun service method.</param> <returns>The response from the ScheduleRun service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.IdempotencyException"> An entity with the same name already exists. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ScheduleRunAsync(Amazon.DeviceFarm.Model.ScheduleRunRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ScheduleRun operation. </summary> <param name="request">Container for the necessary parameters to execute the ScheduleRun operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.UpdateDevicePool(Amazon.DeviceFarm.Model.UpdateDevicePoolRequest)"> <summary> Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all). </summary> <param name="request">Container for the necessary parameters to execute the UpdateDevicePool service method.</param> <returns>The response from the UpdateDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.UpdateDevicePoolAsync(Amazon.DeviceFarm.Model.UpdateDevicePoolRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDevicePool operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDevicePool operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.UpdateProject(Amazon.DeviceFarm.Model.UpdateProjectRequest)"> <summary> Modifies the specified project name, given the project ARN and a new name. </summary> <param name="request">Container for the necessary parameters to execute the UpdateProject service method.</param> <returns>The response from the UpdateProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.UpdateProjectAsync(Amazon.DeviceFarm.Model.UpdateProjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateProject operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateProject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor"> <summary> Constructs AmazonDeviceFarmClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonDeviceFarmClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(Amazon.DeviceFarm.AmazonDeviceFarmConfig)"> <summary> Constructs AmazonDeviceFarmClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonDeviceFarmClient Configuration Object</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonDeviceFarmClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDeviceFarmClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.DeviceFarm.AmazonDeviceFarmConfig)"> <summary> Constructs AmazonDeviceFarmClient with AWS Credentials and an AmazonDeviceFarmClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonDeviceFarmClient Configuration Object</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonDeviceFarmClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDeviceFarmClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(System.String,System.String,Amazon.DeviceFarm.AmazonDeviceFarmConfig)"> <summary> Constructs AmazonDeviceFarmClient with AWS Access Key ID, AWS Secret Key and an AmazonDeviceFarmClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonDeviceFarmClient Configuration Object</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonDeviceFarmClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDeviceFarmClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(System.String,System.String,System.String,Amazon.DeviceFarm.AmazonDeviceFarmConfig)"> <summary> Constructs AmazonDeviceFarmClient with AWS Access Key ID, AWS Secret Key and an AmazonDeviceFarmClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonDeviceFarmClient Configuration Object</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.CreateDevicePool(Amazon.DeviceFarm.Model.CreateDevicePoolRequest)"> <summary> Creates a device pool. </summary> <param name="request">Container for the necessary parameters to execute the CreateDevicePool service method.</param> <returns>The response from the CreateDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.CreateDevicePoolAsync(Amazon.DeviceFarm.Model.CreateDevicePoolRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDevicePool operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDevicePool operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.CreateProject(System.String)"> <summary> Creates a new project. </summary> <param name="name">The project's name.</param> <returns>The response from the CreateProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.CreateProject(Amazon.DeviceFarm.Model.CreateProjectRequest)"> <summary> Creates a new project. </summary> <param name="request">Container for the necessary parameters to execute the CreateProject service method.</param> <returns>The response from the CreateProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.CreateProjectAsync(Amazon.DeviceFarm.Model.CreateProjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateProject operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateProject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.CreateUpload(Amazon.DeviceFarm.Model.CreateUploadRequest)"> <summary> Uploads an app or test scripts. </summary> <param name="request">Container for the necessary parameters to execute the CreateUpload service method.</param> <returns>The response from the CreateUpload service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.CreateUploadAsync(Amazon.DeviceFarm.Model.CreateUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.DeleteDevicePool(Amazon.DeviceFarm.Model.DeleteDevicePoolRequest)"> <summary> Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDevicePool service method.</param> <returns>The response from the DeleteDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.DeleteDevicePoolAsync(Amazon.DeviceFarm.Model.DeleteDevicePoolRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDevicePool operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDevicePool operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.DeleteProject(Amazon.DeviceFarm.Model.DeleteProjectRequest)"> <summary> Deletes an AWS Device Farm project, given the project ARN. <para> <b>Note</b> Deleting this resource does not stop an in-progress run. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteProject service method.</param> <returns>The response from the DeleteProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.DeleteProjectAsync(Amazon.DeviceFarm.Model.DeleteProjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteProject operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteProject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.DeleteRun(Amazon.DeviceFarm.Model.DeleteRunRequest)"> <summary> Deletes the run, given the run ARN. <para> <b>Note</b> Deleting this resource does not stop an in-progress run. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteRun service method.</param> <returns>The response from the DeleteRun service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.DeleteRunAsync(Amazon.DeviceFarm.Model.DeleteRunRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRun operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRun operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.DeleteUpload(Amazon.DeviceFarm.Model.DeleteUploadRequest)"> <summary> Deletes an upload given the upload ARN. </summary> <param name="request">Container for the necessary parameters to execute the DeleteUpload service method.</param> <returns>The response from the DeleteUpload service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.DeleteUploadAsync(Amazon.DeviceFarm.Model.DeleteUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetAccountSettings"> <summary> Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account. </summary> <returns>The response from the GetAccountSettings service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetAccountSettings(Amazon.DeviceFarm.Model.GetAccountSettingsRequest)"> <summary> Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account. </summary> <param name="request">Container for the necessary parameters to execute the GetAccountSettings service method.</param> <returns>The response from the GetAccountSettings service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetAccountSettingsAsync(Amazon.DeviceFarm.Model.GetAccountSettingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetAccountSettings operation. </summary> <param name="request">Container for the necessary parameters to execute the GetAccountSettings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetDevice(System.String)"> <summary> Gets information about a unique device type. </summary> <param name="arn">The device type's ARN.</param> <returns>The response from the GetDevice service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetDevice(Amazon.DeviceFarm.Model.GetDeviceRequest)"> <summary> Gets information about a unique device type. </summary> <param name="request">Container for the necessary parameters to execute the GetDevice service method.</param> <returns>The response from the GetDevice service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetDeviceAsync(Amazon.DeviceFarm.Model.GetDeviceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDevice operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDevice operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetDevicePool(System.String)"> <summary> Gets information about a device pool. </summary> <param name="arn">The device pool's ARN.</param> <returns>The response from the GetDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetDevicePool(Amazon.DeviceFarm.Model.GetDevicePoolRequest)"> <summary> Gets information about a device pool. </summary> <param name="request">Container for the necessary parameters to execute the GetDevicePool service method.</param> <returns>The response from the GetDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetDevicePoolAsync(Amazon.DeviceFarm.Model.GetDevicePoolRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDevicePool operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDevicePool operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetDevicePoolCompatibility(Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityRequest)"> <summary> Gets information about compatibility with a device pool. </summary> <param name="request">Container for the necessary parameters to execute the GetDevicePoolCompatibility service method.</param> <returns>The response from the GetDevicePoolCompatibility service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetDevicePoolCompatibilityAsync(Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDevicePoolCompatibility operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDevicePoolCompatibility operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetJob(System.String)"> <summary> Gets information about a job. </summary> <param name="arn">The job's ARN.</param> <returns>The response from the GetJob service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetJob(Amazon.DeviceFarm.Model.GetJobRequest)"> <summary> Gets information about a job. </summary> <param name="request">Container for the necessary parameters to execute the GetJob service method.</param> <returns>The response from the GetJob service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetJobAsync(Amazon.DeviceFarm.Model.GetJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetJob operation. </summary> <param name="request">Container for the necessary parameters to execute the GetJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetProject(System.String)"> <summary> Gets information about a project. </summary> <param name="arn">The project's ARN.</param> <returns>The response from the GetProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetProject(Amazon.DeviceFarm.Model.GetProjectRequest)"> <summary> Gets information about a project. </summary> <param name="request">Container for the necessary parameters to execute the GetProject service method.</param> <returns>The response from the GetProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetProjectAsync(Amazon.DeviceFarm.Model.GetProjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetProject operation. </summary> <param name="request">Container for the necessary parameters to execute the GetProject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetRun(System.String)"> <summary> Gets information about a run. </summary> <param name="arn">The run's ARN.</param> <returns>The response from the GetRun service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetRun(Amazon.DeviceFarm.Model.GetRunRequest)"> <summary> Gets information about a run. </summary> <param name="request">Container for the necessary parameters to execute the GetRun service method.</param> <returns>The response from the GetRun service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetRunAsync(Amazon.DeviceFarm.Model.GetRunRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetRun operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRun operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetSuite(System.String)"> <summary> Gets information about a suite. </summary> <param name="arn">The suite's ARN.</param> <returns>The response from the GetSuite service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetSuite(Amazon.DeviceFarm.Model.GetSuiteRequest)"> <summary> Gets information about a suite. </summary> <param name="request">Container for the necessary parameters to execute the GetSuite service method.</param> <returns>The response from the GetSuite service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetSuiteAsync(Amazon.DeviceFarm.Model.GetSuiteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSuite operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSuite operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetTest(System.String)"> <summary> Gets information about a test. </summary> <param name="arn">The test's ARN.</param> <returns>The response from the GetTest service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetTest(Amazon.DeviceFarm.Model.GetTestRequest)"> <summary> Gets information about a test. </summary> <param name="request">Container for the necessary parameters to execute the GetTest service method.</param> <returns>The response from the GetTest service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetTestAsync(Amazon.DeviceFarm.Model.GetTestRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetTest operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTest operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetUpload(System.String)"> <summary> Gets information about an upload. </summary> <param name="arn">The upload's ARN.</param> <returns>The response from the GetUpload service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetUpload(Amazon.DeviceFarm.Model.GetUploadRequest)"> <summary> Gets information about an upload. </summary> <param name="request">Container for the necessary parameters to execute the GetUpload service method.</param> <returns>The response from the GetUpload service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetUploadAsync(Amazon.DeviceFarm.Model.GetUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the GetUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListArtifacts(Amazon.DeviceFarm.Model.ListArtifactsRequest)"> <summary> Gets information about artifacts. </summary> <param name="request">Container for the necessary parameters to execute the ListArtifacts service method.</param> <returns>The response from the ListArtifacts service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListArtifactsAsync(Amazon.DeviceFarm.Model.ListArtifactsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListArtifacts operation. </summary> <param name="request">Container for the necessary parameters to execute the ListArtifacts operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListDevicePools(Amazon.DeviceFarm.Model.ListDevicePoolsRequest)"> <summary> Gets information about device pools. </summary> <param name="request">Container for the necessary parameters to execute the ListDevicePools service method.</param> <returns>The response from the ListDevicePools service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListDevicePoolsAsync(Amazon.DeviceFarm.Model.ListDevicePoolsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDevicePools operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDevicePools operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListDevices(Amazon.DeviceFarm.Model.ListDevicesRequest)"> <summary> Gets information about unique device types. </summary> <param name="request">Container for the necessary parameters to execute the ListDevices service method.</param> <returns>The response from the ListDevices service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListDevicesAsync(Amazon.DeviceFarm.Model.ListDevicesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDevices operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDevices operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListJobs(Amazon.DeviceFarm.Model.ListJobsRequest)"> <summary> Gets information about jobs. </summary> <param name="request">Container for the necessary parameters to execute the ListJobs service method.</param> <returns>The response from the ListJobs service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListJobsAsync(Amazon.DeviceFarm.Model.ListJobsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListJobs operation. </summary> <param name="request">Container for the necessary parameters to execute the ListJobs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListProjects(Amazon.DeviceFarm.Model.ListProjectsRequest)"> <summary> Gets information about projects. </summary> <param name="request">Container for the necessary parameters to execute the ListProjects service method.</param> <returns>The response from the ListProjects service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListProjectsAsync(Amazon.DeviceFarm.Model.ListProjectsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListProjects operation. </summary> <param name="request">Container for the necessary parameters to execute the ListProjects operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListRuns(Amazon.DeviceFarm.Model.ListRunsRequest)"> <summary> Gets information about runs. </summary> <param name="request">Container for the necessary parameters to execute the ListRuns service method.</param> <returns>The response from the ListRuns service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListRunsAsync(Amazon.DeviceFarm.Model.ListRunsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListRuns operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRuns operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListSamples(Amazon.DeviceFarm.Model.ListSamplesRequest)"> <summary> Gets information about samples. </summary> <param name="request">Container for the necessary parameters to execute the ListSamples service method.</param> <returns>The response from the ListSamples service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListSamplesAsync(Amazon.DeviceFarm.Model.ListSamplesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListSamples operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSamples operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListSuites(Amazon.DeviceFarm.Model.ListSuitesRequest)"> <summary> Gets information about suites. </summary> <param name="request">Container for the necessary parameters to execute the ListSuites service method.</param> <returns>The response from the ListSuites service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListSuitesAsync(Amazon.DeviceFarm.Model.ListSuitesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListSuites operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSuites operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListTests(Amazon.DeviceFarm.Model.ListTestsRequest)"> <summary> Gets information about tests. </summary> <param name="request">Container for the necessary parameters to execute the ListTests service method.</param> <returns>The response from the ListTests service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListTestsAsync(Amazon.DeviceFarm.Model.ListTestsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTests operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTests operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListUniqueProblems(Amazon.DeviceFarm.Model.ListUniqueProblemsRequest)"> <summary> Gets information about unique problems. </summary> <param name="request">Container for the necessary parameters to execute the ListUniqueProblems service method.</param> <returns>The response from the ListUniqueProblems service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListUniqueProblemsAsync(Amazon.DeviceFarm.Model.ListUniqueProblemsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListUniqueProblems operation. </summary> <param name="request">Container for the necessary parameters to execute the ListUniqueProblems operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListUploads(Amazon.DeviceFarm.Model.ListUploadsRequest)"> <summary> Gets information about uploads. </summary> <param name="request">Container for the necessary parameters to execute the ListUploads service method.</param> <returns>The response from the ListUploads service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListUploadsAsync(Amazon.DeviceFarm.Model.ListUploadsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListUploads operation. </summary> <param name="request">Container for the necessary parameters to execute the ListUploads operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ScheduleRun(Amazon.DeviceFarm.Model.ScheduleRunRequest)"> <summary> Schedules a run. </summary> <param name="request">Container for the necessary parameters to execute the ScheduleRun service method.</param> <returns>The response from the ScheduleRun service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.IdempotencyException"> An entity with the same name already exists. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ScheduleRunAsync(Amazon.DeviceFarm.Model.ScheduleRunRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ScheduleRun operation. </summary> <param name="request">Container for the necessary parameters to execute the ScheduleRun operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.UpdateDevicePool(Amazon.DeviceFarm.Model.UpdateDevicePoolRequest)"> <summary> Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all). </summary> <param name="request">Container for the necessary parameters to execute the UpdateDevicePool service method.</param> <returns>The response from the UpdateDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.UpdateDevicePoolAsync(Amazon.DeviceFarm.Model.UpdateDevicePoolRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDevicePool operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDevicePool operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.UpdateProject(Amazon.DeviceFarm.Model.UpdateProjectRequest)"> <summary> Modifies the specified project name, given the project ARN and a new name. </summary> <param name="request">Container for the necessary parameters to execute the UpdateProject service method.</param> <returns>The response from the UpdateProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.UpdateProjectAsync(Amazon.DeviceFarm.Model.UpdateProjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateProject operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateProject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.DirectConnect.AmazonDirectConnectClient"> <summary> Implementation for accessing DirectConnect AWS Direct Connect makes it easy to establish a dedicated network connection from your premises to Amazon Web Services (AWS). Using AWS Direct Connect, you can establish private connectivity between AWS and your data center, office, or colocation environment, which in many cases can reduce your network costs, increase bandwidth throughput, and provide a more consistent network experience than Internet-based connections. <para> The AWS Direct Connect API Reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Direct Connect. Use the following links to get started using the <i>AWS Direct Connect API Reference</i>: </para> <ul> <li><a href="http://docs.aws.amazon.com/directconnect/latest/APIReference/API_Operations.html">Actions</a>: An alphabetical list of all AWS Direct Connect actions.</li> <li><a href="http://docs.aws.amazon.com/directconnect/latest/APIReference/API_Types.html">Data Types</a>: An alphabetical list of all AWS Direct Connect data types.</li> <li><a href="http://docs.aws.amazon.com/directconnect/latest/APIReference/CommonParameters.html">Common Query Parameters</a>: Parameters that all Query actions can use.</li> <li><a href="http://docs.aws.amazon.com/directconnect/latest/APIReference/CommonErrors.html">Common Errors</a>: Client and server errors that all actions can return.</li> </ul> </summary> </member> <member name="T:Amazon.DirectConnect.IAmazonDirectConnect"> <summary> Interface for accessing DirectConnect AWS Direct Connect makes it easy to establish a dedicated network connection from your premises to Amazon Web Services (AWS). Using AWS Direct Connect, you can establish private connectivity between AWS and your data center, office, or colocation environment, which in many cases can reduce your network costs, increase bandwidth throughput, and provide a more consistent network experience than Internet-based connections. <para> The AWS Direct Connect API Reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Direct Connect. Use the following links to get started using the <i>AWS Direct Connect API Reference</i>: </para> <ul> <li><a href="http://docs.aws.amazon.com/directconnect/latest/APIReference/API_Operations.html">Actions</a>: An alphabetical list of all AWS Direct Connect actions.</li> <li><a href="http://docs.aws.amazon.com/directconnect/latest/APIReference/API_Types.html">Data Types</a>: An alphabetical list of all AWS Direct Connect data types.</li> <li><a href="http://docs.aws.amazon.com/directconnect/latest/APIReference/CommonParameters.html">Common Query Parameters</a>: Parameters that all Query actions can use.</li> <li><a href="http://docs.aws.amazon.com/directconnect/latest/APIReference/CommonErrors.html">Common Errors</a>: Client and server errors that all actions can return.</li> </ul> </summary> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.AllocateConnectionOnInterconnect(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest)"> <summary> Creates a hosted connection on an interconnect. <para> Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect. </para> </summary> <param name="request">Container for the necessary parameters to execute the AllocateConnectionOnInterconnect service method.</param> <returns>The response from the AllocateConnectionOnInterconnect service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.AllocateConnectionOnInterconnectAsync(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AllocateConnectionOnInterconnect operation. </summary> <param name="request">Container for the necessary parameters to execute the AllocateConnectionOnInterconnect operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.AllocatePrivateVirtualInterface(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest)"> <summary> Provisions a private virtual interface to be owned by a different customer. <para> The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer. </para> <para> Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic. </para> </summary> <param name="request">Container for the necessary parameters to execute the AllocatePrivateVirtualInterface service method.</param> <returns>The response from the AllocatePrivateVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.AllocatePrivateVirtualInterfaceAsync(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AllocatePrivateVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the AllocatePrivateVirtualInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.AllocatePublicVirtualInterface(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest)"> <summary> Provisions a public virtual interface to be owned by a different customer. <para> The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer. </para> <para> Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic. </para> </summary> <param name="request">Container for the necessary parameters to execute the AllocatePublicVirtualInterface service method.</param> <returns>The response from the AllocatePublicVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.AllocatePublicVirtualInterfaceAsync(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AllocatePublicVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the AllocatePublicVirtualInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.ConfirmConnection(Amazon.DirectConnect.Model.ConfirmConnectionRequest)"> <summary> Confirm the creation of a hosted connection on an interconnect. <para> Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection. </para> </summary> <param name="request">Container for the necessary parameters to execute the ConfirmConnection service method.</param> <returns>The response from the ConfirmConnection service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.ConfirmConnectionAsync(Amazon.DirectConnect.Model.ConfirmConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ConfirmConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.ConfirmPrivateVirtualInterface(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest)"> <summary> Accept ownership of a private virtual interface created by another customer. <para> After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic. </para> </summary> <param name="request">Container for the necessary parameters to execute the ConfirmPrivateVirtualInterface service method.</param> <returns>The response from the ConfirmPrivateVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.ConfirmPrivateVirtualInterfaceAsync(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ConfirmPrivateVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmPrivateVirtualInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.ConfirmPublicVirtualInterface(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest)"> <summary> Accept ownership of a public virtual interface created by another customer. <para> After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic. </para> </summary> <param name="request">Container for the necessary parameters to execute the ConfirmPublicVirtualInterface service method.</param> <returns>The response from the ConfirmPublicVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.ConfirmPublicVirtualInterfaceAsync(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ConfirmPublicVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmPublicVirtualInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.CreateConnection(Amazon.DirectConnect.Model.CreateConnectionRequest)"> <summary> Creates a new connection between the customer network and a specific AWS Direct Connect location. <para> A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateConnection service method.</param> <returns>The response from the CreateConnection service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.CreateConnectionAsync(Amazon.DirectConnect.Model.CreateConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.CreateInterconnect(Amazon.DirectConnect.Model.CreateInterconnectRequest)"> <summary> Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location. <para> An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router. </para> <para> For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateInterconnect service method.</param> <returns>The response from the CreateInterconnect service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.CreateInterconnectAsync(Amazon.DirectConnect.Model.CreateInterconnectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateInterconnect operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInterconnect operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.CreatePrivateVirtualInterface(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest)"> <summary> Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC). </summary> <param name="request">Container for the necessary parameters to execute the CreatePrivateVirtualInterface service method.</param> <returns>The response from the CreatePrivateVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.CreatePrivateVirtualInterfaceAsync(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePrivateVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePrivateVirtualInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.CreatePublicVirtualInterface(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest)"> <summary> Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3). </summary> <param name="request">Container for the necessary parameters to execute the CreatePublicVirtualInterface service method.</param> <returns>The response from the CreatePublicVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.CreatePublicVirtualInterfaceAsync(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePublicVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePublicVirtualInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DeleteConnection(Amazon.DirectConnect.Model.DeleteConnectionRequest)"> <summary> Deletes the connection. <para> Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteConnection service method.</param> <returns>The response from the DeleteConnection service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DeleteConnectionAsync(Amazon.DirectConnect.Model.DeleteConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DeleteInterconnect(Amazon.DirectConnect.Model.DeleteInterconnectRequest)"> <summary> Deletes the specified interconnect. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInterconnect service method.</param> <returns>The response from the DeleteInterconnect service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DeleteInterconnectAsync(Amazon.DirectConnect.Model.DeleteInterconnectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteInterconnect operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInterconnect operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DeleteVirtualInterface(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest)"> <summary> Deletes a virtual interface. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVirtualInterface service method.</param> <returns>The response from the DeleteVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DeleteVirtualInterfaceAsync(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVirtualInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeConnections"> <summary> Displays all connections in this region. <para> If a connection ID is provided, the call returns only that particular connection. </para> </summary> <returns>The response from the DescribeConnections service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeConnections(Amazon.DirectConnect.Model.DescribeConnectionsRequest)"> <summary> Displays all connections in this region. <para> If a connection ID is provided, the call returns only that particular connection. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConnections service method.</param> <returns>The response from the DescribeConnections service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeConnectionsAsync(Amazon.DirectConnect.Model.DescribeConnectionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConnections operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConnections operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeConnectionsOnInterconnect(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest)"> <summary> Return a list of connections that have been provisioned on the given interconnect. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConnectionsOnInterconnect service method.</param> <returns>The response from the DescribeConnectionsOnInterconnect service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeConnectionsOnInterconnectAsync(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConnectionsOnInterconnect operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConnectionsOnInterconnect operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeInterconnects"> <summary> Returns a list of interconnects owned by the AWS account. <para> If an interconnect ID is provided, it will only return this particular interconnect. </para> </summary> <returns>The response from the DescribeInterconnects service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeInterconnects(Amazon.DirectConnect.Model.DescribeInterconnectsRequest)"> <summary> Returns a list of interconnects owned by the AWS account. <para> If an interconnect ID is provided, it will only return this particular interconnect. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInterconnects service method.</param> <returns>The response from the DescribeInterconnects service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeInterconnectsAsync(Amazon.DirectConnect.Model.DescribeInterconnectsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInterconnects operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInterconnects operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeLocations"> <summary> Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect. </summary> <returns>The response from the DescribeLocations service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeLocations(Amazon.DirectConnect.Model.DescribeLocationsRequest)"> <summary> Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLocations service method.</param> <returns>The response from the DescribeLocations service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeLocationsAsync(Amazon.DirectConnect.Model.DescribeLocationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLocations operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLocations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeVirtualGateways"> <summary> Returns a list of virtual private gateways owned by the AWS account. <para> You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html">EC2 CreateVpnGateway</a> action. </para> </summary> <returns>The response from the DescribeVirtualGateways service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeVirtualGateways(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest)"> <summary> Returns a list of virtual private gateways owned by the AWS account. <para> You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html">EC2 CreateVpnGateway</a> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVirtualGateways service method.</param> <returns>The response from the DescribeVirtualGateways service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeVirtualGatewaysAsync(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVirtualGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVirtualGateways operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeVirtualInterfaces"> <summary> Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned. <para> A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer. </para> <para> If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned. </para> </summary> <returns>The response from the DescribeVirtualInterfaces service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeVirtualInterfaces(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest)"> <summary> Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned. <para> A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer. </para> <para> If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVirtualInterfaces service method.</param> <returns>The response from the DescribeVirtualInterfaces service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeVirtualInterfacesAsync(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVirtualInterfaces operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVirtualInterfaces operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor"> <summary> Constructs AmazonDirectConnectClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonDirectConnectClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(Amazon.DirectConnect.AmazonDirectConnectConfig)"> <summary> Constructs AmazonDirectConnectClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonDirectConnectClient Configuration Object</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonDirectConnectClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDirectConnectClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.DirectConnect.AmazonDirectConnectConfig)"> <summary> Constructs AmazonDirectConnectClient with AWS Credentials and an AmazonDirectConnectClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonDirectConnectClient Configuration Object</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonDirectConnectClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDirectConnectClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(System.String,System.String,Amazon.DirectConnect.AmazonDirectConnectConfig)"> <summary> Constructs AmazonDirectConnectClient with AWS Access Key ID, AWS Secret Key and an AmazonDirectConnectClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonDirectConnectClient Configuration Object</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonDirectConnectClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDirectConnectClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(System.String,System.String,System.String,Amazon.DirectConnect.AmazonDirectConnectConfig)"> <summary> Constructs AmazonDirectConnectClient with AWS Access Key ID, AWS Secret Key and an AmazonDirectConnectClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonDirectConnectClient Configuration Object</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.AllocateConnectionOnInterconnect(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest)"> <summary> Creates a hosted connection on an interconnect. <para> Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect. </para> </summary> <param name="request">Container for the necessary parameters to execute the AllocateConnectionOnInterconnect service method.</param> <returns>The response from the AllocateConnectionOnInterconnect service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.AllocateConnectionOnInterconnectAsync(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AllocateConnectionOnInterconnect operation. </summary> <param name="request">Container for the necessary parameters to execute the AllocateConnectionOnInterconnect operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.AllocatePrivateVirtualInterface(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest)"> <summary> Provisions a private virtual interface to be owned by a different customer. <para> The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer. </para> <para> Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic. </para> </summary> <param name="request">Container for the necessary parameters to execute the AllocatePrivateVirtualInterface service method.</param> <returns>The response from the AllocatePrivateVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.AllocatePrivateVirtualInterfaceAsync(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AllocatePrivateVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the AllocatePrivateVirtualInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.AllocatePublicVirtualInterface(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest)"> <summary> Provisions a public virtual interface to be owned by a different customer. <para> The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer. </para> <para> Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic. </para> </summary> <param name="request">Container for the necessary parameters to execute the AllocatePublicVirtualInterface service method.</param> <returns>The response from the AllocatePublicVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.AllocatePublicVirtualInterfaceAsync(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AllocatePublicVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the AllocatePublicVirtualInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.ConfirmConnection(Amazon.DirectConnect.Model.ConfirmConnectionRequest)"> <summary> Confirm the creation of a hosted connection on an interconnect. <para> Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection. </para> </summary> <param name="request">Container for the necessary parameters to execute the ConfirmConnection service method.</param> <returns>The response from the ConfirmConnection service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.ConfirmConnectionAsync(Amazon.DirectConnect.Model.ConfirmConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ConfirmConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.ConfirmPrivateVirtualInterface(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest)"> <summary> Accept ownership of a private virtual interface created by another customer. <para> After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic. </para> </summary> <param name="request">Container for the necessary parameters to execute the ConfirmPrivateVirtualInterface service method.</param> <returns>The response from the ConfirmPrivateVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.ConfirmPrivateVirtualInterfaceAsync(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ConfirmPrivateVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmPrivateVirtualInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.ConfirmPublicVirtualInterface(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest)"> <summary> Accept ownership of a public virtual interface created by another customer. <para> After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic. </para> </summary> <param name="request">Container for the necessary parameters to execute the ConfirmPublicVirtualInterface service method.</param> <returns>The response from the ConfirmPublicVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.ConfirmPublicVirtualInterfaceAsync(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ConfirmPublicVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmPublicVirtualInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.CreateConnection(Amazon.DirectConnect.Model.CreateConnectionRequest)"> <summary> Creates a new connection between the customer network and a specific AWS Direct Connect location. <para> A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateConnection service method.</param> <returns>The response from the CreateConnection service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.CreateConnectionAsync(Amazon.DirectConnect.Model.CreateConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.CreateInterconnect(Amazon.DirectConnect.Model.CreateInterconnectRequest)"> <summary> Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location. <para> An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router. </para> <para> For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateInterconnect service method.</param> <returns>The response from the CreateInterconnect service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.CreateInterconnectAsync(Amazon.DirectConnect.Model.CreateInterconnectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateInterconnect operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInterconnect operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.CreatePrivateVirtualInterface(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest)"> <summary> Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC). </summary> <param name="request">Container for the necessary parameters to execute the CreatePrivateVirtualInterface service method.</param> <returns>The response from the CreatePrivateVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.CreatePrivateVirtualInterfaceAsync(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePrivateVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePrivateVirtualInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.CreatePublicVirtualInterface(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest)"> <summary> Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3). </summary> <param name="request">Container for the necessary parameters to execute the CreatePublicVirtualInterface service method.</param> <returns>The response from the CreatePublicVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.CreatePublicVirtualInterfaceAsync(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePublicVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePublicVirtualInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DeleteConnection(Amazon.DirectConnect.Model.DeleteConnectionRequest)"> <summary> Deletes the connection. <para> Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteConnection service method.</param> <returns>The response from the DeleteConnection service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DeleteConnectionAsync(Amazon.DirectConnect.Model.DeleteConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DeleteInterconnect(Amazon.DirectConnect.Model.DeleteInterconnectRequest)"> <summary> Deletes the specified interconnect. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInterconnect service method.</param> <returns>The response from the DeleteInterconnect service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DeleteInterconnectAsync(Amazon.DirectConnect.Model.DeleteInterconnectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteInterconnect operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInterconnect operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DeleteVirtualInterface(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest)"> <summary> Deletes a virtual interface. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVirtualInterface service method.</param> <returns>The response from the DeleteVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DeleteVirtualInterfaceAsync(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVirtualInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeConnections"> <summary> Displays all connections in this region. <para> If a connection ID is provided, the call returns only that particular connection. </para> </summary> <returns>The response from the DescribeConnections service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeConnections(Amazon.DirectConnect.Model.DescribeConnectionsRequest)"> <summary> Displays all connections in this region. <para> If a connection ID is provided, the call returns only that particular connection. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConnections service method.</param> <returns>The response from the DescribeConnections service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeConnectionsAsync(Amazon.DirectConnect.Model.DescribeConnectionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConnections operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConnections operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeConnectionsOnInterconnect(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest)"> <summary> Return a list of connections that have been provisioned on the given interconnect. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConnectionsOnInterconnect service method.</param> <returns>The response from the DescribeConnectionsOnInterconnect service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeConnectionsOnInterconnectAsync(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConnectionsOnInterconnect operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConnectionsOnInterconnect operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeInterconnects"> <summary> Returns a list of interconnects owned by the AWS account. <para> If an interconnect ID is provided, it will only return this particular interconnect. </para> </summary> <returns>The response from the DescribeInterconnects service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeInterconnects(Amazon.DirectConnect.Model.DescribeInterconnectsRequest)"> <summary> Returns a list of interconnects owned by the AWS account. <para> If an interconnect ID is provided, it will only return this particular interconnect. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInterconnects service method.</param> <returns>The response from the DescribeInterconnects service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeInterconnectsAsync(Amazon.DirectConnect.Model.DescribeInterconnectsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInterconnects operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInterconnects operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeLocations"> <summary> Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect. </summary> <returns>The response from the DescribeLocations service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeLocations(Amazon.DirectConnect.Model.DescribeLocationsRequest)"> <summary> Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLocations service method.</param> <returns>The response from the DescribeLocations service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeLocationsAsync(Amazon.DirectConnect.Model.DescribeLocationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLocations operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLocations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeVirtualGateways"> <summary> Returns a list of virtual private gateways owned by the AWS account. <para> You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html">EC2 CreateVpnGateway</a> action. </para> </summary> <returns>The response from the DescribeVirtualGateways service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeVirtualGateways(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest)"> <summary> Returns a list of virtual private gateways owned by the AWS account. <para> You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html">EC2 CreateVpnGateway</a> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVirtualGateways service method.</param> <returns>The response from the DescribeVirtualGateways service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeVirtualGatewaysAsync(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVirtualGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVirtualGateways operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeVirtualInterfaces"> <summary> Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned. <para> A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer. </para> <para> If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned. </para> </summary> <returns>The response from the DescribeVirtualInterfaces service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeVirtualInterfaces(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest)"> <summary> Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned. <para> A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer. </para> <para> If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVirtualInterfaces service method.</param> <returns>The response from the DescribeVirtualInterfaces service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeVirtualInterfacesAsync(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVirtualInterfaces operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVirtualInterfaces operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.DirectoryService.AmazonDirectoryServiceClient"> <summary> Implementation for accessing DirectoryService AWS Directory Service <para> This is the <i>AWS Directory Service API Reference</i>. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. </para> </summary> </member> <member name="T:Amazon.DirectoryService.IAmazonDirectoryService"> <summary> Interface for accessing DirectoryService AWS Directory Service <para> This is the <i>AWS Directory Service API Reference</i>. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. </para> </summary> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.ConnectDirectory(Amazon.DirectoryService.Model.ConnectDirectoryRequest)"> <summary> Creates an AD Connector to connect to an on-premises directory. </summary> <param name="request">Container for the necessary parameters to execute the ConnectDirectory service method.</param> <returns>The response from the ConnectDirectory service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.DirectoryLimitExceededException"> The maximum number of directories in the region has been reached. You can use the <a>GetDirectoryLimits</a> operation to determine your directory limits in the region. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.ConnectDirectoryAsync(Amazon.DirectoryService.Model.ConnectDirectoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ConnectDirectory operation. </summary> <param name="request">Container for the necessary parameters to execute the ConnectDirectory operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateAlias(Amazon.DirectoryService.Model.CreateAliasRequest)"> <summary> Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as <code>http://<![CDATA[<]]>alias<![CDATA[>]]>.awsapps.com</code>. <important> <para> After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the CreateAlias service method.</param> <returns>The response from the CreateAlias service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> The specified entity already exists. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateAliasAsync(Amazon.DirectoryService.Model.CreateAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateComputer(Amazon.DirectoryService.Model.CreateComputerRequest)"> <summary> Creates a computer account in the specified directory, and joins the computer to the directory. </summary> <param name="request">Container for the necessary parameters to execute the CreateComputer service method.</param> <returns>The response from the CreateComputer service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.AuthenticationFailedException"> An authentication error occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.DirectoryUnavailableException"> The specified directory is unavailable or could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> The specified entity already exists. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateComputerAsync(Amazon.DirectoryService.Model.CreateComputerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateComputer operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateComputer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateDirectory(Amazon.DirectoryService.Model.CreateDirectoryRequest)"> <summary> Creates a Simple AD directory. </summary> <param name="request">Container for the necessary parameters to execute the CreateDirectory service method.</param> <returns>The response from the CreateDirectory service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.DirectoryLimitExceededException"> The maximum number of directories in the region has been reached. You can use the <a>GetDirectoryLimits</a> operation to determine your directory limits in the region. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateDirectoryAsync(Amazon.DirectoryService.Model.CreateDirectoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDirectory operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDirectory operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateMicrosoftAD(Amazon.DirectoryService.Model.CreateMicrosoftADRequest)"> <summary> Creates a Microsoft AD in the AWS cloud. </summary> <param name="request">Container for the necessary parameters to execute the CreateMicrosoftAD service method.</param> <returns>The response from the CreateMicrosoftAD service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.DirectoryLimitExceededException"> The maximum number of directories in the region has been reached. You can use the <a>GetDirectoryLimits</a> operation to determine your directory limits in the region. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateMicrosoftADAsync(Amazon.DirectoryService.Model.CreateMicrosoftADRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateMicrosoftAD operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateMicrosoftAD operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateSnapshot(Amazon.DirectoryService.Model.CreateSnapshotRequest)"> <summary> Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud. <note> <para> You cannot take snapshots of AD Connector directories. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot service method.</param> <returns>The response from the CreateSnapshot service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.SnapshotLimitExceededException"> The maximum number of manual snapshots for the directory has been reached. You can use the <a>GetSnapshotLimits</a> operation to determine the snapshot limits for a directory. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateSnapshotAsync(Amazon.DirectoryService.Model.CreateSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateTrust(Amazon.DirectoryService.Model.CreateTrustRequest)"> <summary> AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials. <para> This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateTrust service method.</param> <returns>The response from the CreateTrust service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> The specified entity already exists. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateTrustAsync(Amazon.DirectoryService.Model.CreateTrustRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTrust operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrust operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DeleteDirectory(Amazon.DirectoryService.Model.DeleteDirectoryRequest)"> <summary> Deletes an AWS Directory Service directory. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDirectory service method.</param> <returns>The response from the DeleteDirectory service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DeleteDirectoryAsync(Amazon.DirectoryService.Model.DeleteDirectoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDirectory operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDirectory operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DeleteSnapshot(Amazon.DirectoryService.Model.DeleteSnapshotRequest)"> <summary> Deletes a directory snapshot. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot service method.</param> <returns>The response from the DeleteSnapshot service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DeleteSnapshotAsync(Amazon.DirectoryService.Model.DeleteSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DeleteTrust(Amazon.DirectoryService.Model.DeleteTrustRequest)"> <summary> Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrust service method.</param> <returns>The response from the DeleteTrust service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DeleteTrustAsync(Amazon.DirectoryService.Model.DeleteTrustRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTrust operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrust operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DeregisterEventTopic(Amazon.DirectoryService.Model.DeregisterEventTopicRequest)"> <summary> Removes the specified directory as a publisher to the specified SNS topic. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterEventTopic service method.</param> <returns>The response from the DeregisterEventTopic service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DeregisterEventTopicAsync(Amazon.DirectoryService.Model.DeregisterEventTopicRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterEventTopic operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterEventTopic operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DescribeDirectories"> <summary> Obtains information about the directories that belong to this account. <para> You can retrieve information about specific directories by passing the directory identifiers in the <i>DirectoryIds</i> parameter. Otherwise, all directories that belong to the current account are returned. </para> <para> This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeDirectoriesResult.NextToken</i> member contains a token that you pass in the next call to <a>DescribeDirectories</a> to retrieve the next set of items. </para> <para> You can also specify a maximum number of return results with the <i>Limit</i> parameter. </para> </summary> <returns>The response from the DescribeDirectories service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> The <i>NextToken</i> value is not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DescribeDirectories(Amazon.DirectoryService.Model.DescribeDirectoriesRequest)"> <summary> Obtains information about the directories that belong to this account. <para> You can retrieve information about specific directories by passing the directory identifiers in the <i>DirectoryIds</i> parameter. Otherwise, all directories that belong to the current account are returned. </para> <para> This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeDirectoriesResult.NextToken</i> member contains a token that you pass in the next call to <a>DescribeDirectories</a> to retrieve the next set of items. </para> <para> You can also specify a maximum number of return results with the <i>Limit</i> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDirectories service method.</param> <returns>The response from the DescribeDirectories service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> The <i>NextToken</i> value is not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DescribeDirectoriesAsync(Amazon.DirectoryService.Model.DescribeDirectoriesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDirectories operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDirectories operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DescribeEventTopics(Amazon.DirectoryService.Model.DescribeEventTopicsRequest)"> <summary> Obtains information about which SNS topics receive status messages from the specified directory. <para> If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventTopics service method.</param> <returns>The response from the DescribeEventTopics service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DescribeEventTopicsAsync(Amazon.DirectoryService.Model.DescribeEventTopicsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEventTopics operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventTopics operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DescribeSnapshots(Amazon.DirectoryService.Model.DescribeSnapshotsRequest)"> <summary> Obtains information about the directory snapshots that belong to this account. <para> This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeSnapshots.NextToken</i> member contains a token that you pass in the next call to <a>DescribeSnapshots</a> to retrieve the next set of items. </para> <para> You can also specify a maximum number of return results with the <i>Limit</i> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots service method.</param> <returns>The response from the DescribeSnapshots service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> The <i>NextToken</i> value is not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DescribeSnapshotsAsync(Amazon.DirectoryService.Model.DescribeSnapshotsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSnapshots operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DescribeTrusts(Amazon.DirectoryService.Model.DescribeTrustsRequest)"> <summary> Obtains information about the trust relationships for this account. <para> If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrusts service method.</param> <returns>The response from the DescribeTrusts service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> The <i>NextToken</i> value is not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DescribeTrustsAsync(Amazon.DirectoryService.Model.DescribeTrustsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTrusts operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrusts operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DisableRadius(Amazon.DirectoryService.Model.DisableRadiusRequest)"> <summary> Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory. </summary> <param name="request">Container for the necessary parameters to execute the DisableRadius service method.</param> <returns>The response from the DisableRadius service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DisableRadiusAsync(Amazon.DirectoryService.Model.DisableRadiusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableRadius operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableRadius operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DisableSso(Amazon.DirectoryService.Model.DisableSsoRequest)"> <summary> Disables single-sign on for a directory. </summary> <param name="request">Container for the necessary parameters to execute the DisableSso service method.</param> <returns>The response from the DisableSso service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.AuthenticationFailedException"> An authentication error occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InsufficientPermissionsException"> The account does not have sufficient permission to perform the operation. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DisableSsoAsync(Amazon.DirectoryService.Model.DisableSsoRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableSso operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableSso operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EnableRadius(Amazon.DirectoryService.Model.EnableRadiusRequest)"> <summary> Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory. </summary> <param name="request">Container for the necessary parameters to execute the EnableRadius service method.</param> <returns>The response from the EnableRadius service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> The specified entity already exists. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EnableRadiusAsync(Amazon.DirectoryService.Model.EnableRadiusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableRadius operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableRadius operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EnableSso(Amazon.DirectoryService.Model.EnableSsoRequest)"> <summary> Enables single-sign on for a directory. </summary> <param name="request">Container for the necessary parameters to execute the EnableSso service method.</param> <returns>The response from the EnableSso service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.AuthenticationFailedException"> An authentication error occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InsufficientPermissionsException"> The account does not have sufficient permission to perform the operation. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EnableSsoAsync(Amazon.DirectoryService.Model.EnableSsoRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableSso operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableSso operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.GetDirectoryLimits"> <summary> Obtains directory limit information for the current region. </summary> <returns>The response from the GetDirectoryLimits service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.GetDirectoryLimits(Amazon.DirectoryService.Model.GetDirectoryLimitsRequest)"> <summary> Obtains directory limit information for the current region. </summary> <param name="request">Container for the necessary parameters to execute the GetDirectoryLimits service method.</param> <returns>The response from the GetDirectoryLimits service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.GetDirectoryLimitsAsync(Amazon.DirectoryService.Model.GetDirectoryLimitsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDirectoryLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDirectoryLimits operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.GetSnapshotLimits(Amazon.DirectoryService.Model.GetSnapshotLimitsRequest)"> <summary> Obtains the manual snapshot limits for a directory. </summary> <param name="request">Container for the necessary parameters to execute the GetSnapshotLimits service method.</param> <returns>The response from the GetSnapshotLimits service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.GetSnapshotLimitsAsync(Amazon.DirectoryService.Model.GetSnapshotLimitsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSnapshotLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSnapshotLimits operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.RegisterEventTopic(Amazon.DirectoryService.Model.RegisterEventTopicRequest)"> <summary> Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status. </summary> <param name="request">Container for the necessary parameters to execute the RegisterEventTopic service method.</param> <returns>The response from the RegisterEventTopic service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.RegisterEventTopicAsync(Amazon.DirectoryService.Model.RegisterEventTopicRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterEventTopic operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterEventTopic operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.RestoreFromSnapshot(Amazon.DirectoryService.Model.RestoreFromSnapshotRequest)"> <summary> Restores a directory using an existing directory snapshot. <para> When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten. </para> <para> This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the <a>DescribeDirectories</a> operation with the directory identifier. When the <b>DirectoryDescription.Stage</b> value changes to <code>Active</code>, the restore operation is complete. </para> </summary> <param name="request">Container for the necessary parameters to execute the RestoreFromSnapshot service method.</param> <returns>The response from the RestoreFromSnapshot service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.RestoreFromSnapshotAsync(Amazon.DirectoryService.Model.RestoreFromSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestoreFromSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreFromSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.UpdateRadius(Amazon.DirectoryService.Model.UpdateRadiusRequest)"> <summary> Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRadius service method.</param> <returns>The response from the UpdateRadius service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.UpdateRadiusAsync(Amazon.DirectoryService.Model.UpdateRadiusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateRadius operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRadius operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.VerifyTrust(Amazon.DirectoryService.Model.VerifyTrustRequest)"> <summary> AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships. <para> This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain. </para> </summary> <param name="request">Container for the necessary parameters to execute the VerifyTrust service method.</param> <returns>The response from the VerifyTrust service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.VerifyTrustAsync(Amazon.DirectoryService.Model.VerifyTrustRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the VerifyTrust operation. </summary> <param name="request">Container for the necessary parameters to execute the VerifyTrust operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor"> <summary> Constructs AmazonDirectoryServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonDirectoryServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(Amazon.DirectoryService.AmazonDirectoryServiceConfig)"> <summary> Constructs AmazonDirectoryServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonDirectoryServiceClient Configuration Object</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.DirectoryService.AmazonDirectoryServiceConfig)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Credentials and an AmazonDirectoryServiceClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonDirectoryServiceClient Configuration Object</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(System.String,System.String,Amazon.DirectoryService.AmazonDirectoryServiceConfig)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonDirectoryServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonDirectoryServiceClient Configuration Object</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(System.String,System.String,System.String,Amazon.DirectoryService.AmazonDirectoryServiceConfig)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonDirectoryServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonDirectoryServiceClient Configuration Object</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.ConnectDirectory(Amazon.DirectoryService.Model.ConnectDirectoryRequest)"> <summary> Creates an AD Connector to connect to an on-premises directory. </summary> <param name="request">Container for the necessary parameters to execute the ConnectDirectory service method.</param> <returns>The response from the ConnectDirectory service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.DirectoryLimitExceededException"> The maximum number of directories in the region has been reached. You can use the <a>GetDirectoryLimits</a> operation to determine your directory limits in the region. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.ConnectDirectoryAsync(Amazon.DirectoryService.Model.ConnectDirectoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ConnectDirectory operation. </summary> <param name="request">Container for the necessary parameters to execute the ConnectDirectory operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateAlias(Amazon.DirectoryService.Model.CreateAliasRequest)"> <summary> Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as <code>http://<![CDATA[<]]>alias<![CDATA[>]]>.awsapps.com</code>. <important> <para> After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the CreateAlias service method.</param> <returns>The response from the CreateAlias service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> The specified entity already exists. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateAliasAsync(Amazon.DirectoryService.Model.CreateAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateComputer(Amazon.DirectoryService.Model.CreateComputerRequest)"> <summary> Creates a computer account in the specified directory, and joins the computer to the directory. </summary> <param name="request">Container for the necessary parameters to execute the CreateComputer service method.</param> <returns>The response from the CreateComputer service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.AuthenticationFailedException"> An authentication error occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.DirectoryUnavailableException"> The specified directory is unavailable or could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> The specified entity already exists. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateComputerAsync(Amazon.DirectoryService.Model.CreateComputerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateComputer operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateComputer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateDirectory(Amazon.DirectoryService.Model.CreateDirectoryRequest)"> <summary> Creates a Simple AD directory. </summary> <param name="request">Container for the necessary parameters to execute the CreateDirectory service method.</param> <returns>The response from the CreateDirectory service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.DirectoryLimitExceededException"> The maximum number of directories in the region has been reached. You can use the <a>GetDirectoryLimits</a> operation to determine your directory limits in the region. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateDirectoryAsync(Amazon.DirectoryService.Model.CreateDirectoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDirectory operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDirectory operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateMicrosoftAD(Amazon.DirectoryService.Model.CreateMicrosoftADRequest)"> <summary> Creates a Microsoft AD in the AWS cloud. </summary> <param name="request">Container for the necessary parameters to execute the CreateMicrosoftAD service method.</param> <returns>The response from the CreateMicrosoftAD service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.DirectoryLimitExceededException"> The maximum number of directories in the region has been reached. You can use the <a>GetDirectoryLimits</a> operation to determine your directory limits in the region. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateMicrosoftADAsync(Amazon.DirectoryService.Model.CreateMicrosoftADRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateMicrosoftAD operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateMicrosoftAD operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateSnapshot(Amazon.DirectoryService.Model.CreateSnapshotRequest)"> <summary> Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud. <note> <para> You cannot take snapshots of AD Connector directories. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot service method.</param> <returns>The response from the CreateSnapshot service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.SnapshotLimitExceededException"> The maximum number of manual snapshots for the directory has been reached. You can use the <a>GetSnapshotLimits</a> operation to determine the snapshot limits for a directory. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateSnapshotAsync(Amazon.DirectoryService.Model.CreateSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateTrust(Amazon.DirectoryService.Model.CreateTrustRequest)"> <summary> AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials. <para> This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateTrust service method.</param> <returns>The response from the CreateTrust service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> The specified entity already exists. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateTrustAsync(Amazon.DirectoryService.Model.CreateTrustRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTrust operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrust operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DeleteDirectory(Amazon.DirectoryService.Model.DeleteDirectoryRequest)"> <summary> Deletes an AWS Directory Service directory. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDirectory service method.</param> <returns>The response from the DeleteDirectory service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DeleteDirectoryAsync(Amazon.DirectoryService.Model.DeleteDirectoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDirectory operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDirectory operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DeleteSnapshot(Amazon.DirectoryService.Model.DeleteSnapshotRequest)"> <summary> Deletes a directory snapshot. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot service method.</param> <returns>The response from the DeleteSnapshot service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DeleteSnapshotAsync(Amazon.DirectoryService.Model.DeleteSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DeleteTrust(Amazon.DirectoryService.Model.DeleteTrustRequest)"> <summary> Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrust service method.</param> <returns>The response from the DeleteTrust service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DeleteTrustAsync(Amazon.DirectoryService.Model.DeleteTrustRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTrust operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrust operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DeregisterEventTopic(Amazon.DirectoryService.Model.DeregisterEventTopicRequest)"> <summary> Removes the specified directory as a publisher to the specified SNS topic. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterEventTopic service method.</param> <returns>The response from the DeregisterEventTopic service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DeregisterEventTopicAsync(Amazon.DirectoryService.Model.DeregisterEventTopicRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterEventTopic operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterEventTopic operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DescribeDirectories"> <summary> Obtains information about the directories that belong to this account. <para> You can retrieve information about specific directories by passing the directory identifiers in the <i>DirectoryIds</i> parameter. Otherwise, all directories that belong to the current account are returned. </para> <para> This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeDirectoriesResult.NextToken</i> member contains a token that you pass in the next call to <a>DescribeDirectories</a> to retrieve the next set of items. </para> <para> You can also specify a maximum number of return results with the <i>Limit</i> parameter. </para> </summary> <returns>The response from the DescribeDirectories service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> The <i>NextToken</i> value is not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DescribeDirectories(Amazon.DirectoryService.Model.DescribeDirectoriesRequest)"> <summary> Obtains information about the directories that belong to this account. <para> You can retrieve information about specific directories by passing the directory identifiers in the <i>DirectoryIds</i> parameter. Otherwise, all directories that belong to the current account are returned. </para> <para> This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeDirectoriesResult.NextToken</i> member contains a token that you pass in the next call to <a>DescribeDirectories</a> to retrieve the next set of items. </para> <para> You can also specify a maximum number of return results with the <i>Limit</i> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDirectories service method.</param> <returns>The response from the DescribeDirectories service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> The <i>NextToken</i> value is not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DescribeDirectoriesAsync(Amazon.DirectoryService.Model.DescribeDirectoriesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDirectories operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDirectories operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DescribeEventTopics(Amazon.DirectoryService.Model.DescribeEventTopicsRequest)"> <summary> Obtains information about which SNS topics receive status messages from the specified directory. <para> If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventTopics service method.</param> <returns>The response from the DescribeEventTopics service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DescribeEventTopicsAsync(Amazon.DirectoryService.Model.DescribeEventTopicsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEventTopics operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventTopics operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DescribeSnapshots(Amazon.DirectoryService.Model.DescribeSnapshotsRequest)"> <summary> Obtains information about the directory snapshots that belong to this account. <para> This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeSnapshots.NextToken</i> member contains a token that you pass in the next call to <a>DescribeSnapshots</a> to retrieve the next set of items. </para> <para> You can also specify a maximum number of return results with the <i>Limit</i> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots service method.</param> <returns>The response from the DescribeSnapshots service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> The <i>NextToken</i> value is not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DescribeSnapshotsAsync(Amazon.DirectoryService.Model.DescribeSnapshotsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSnapshots operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DescribeTrusts(Amazon.DirectoryService.Model.DescribeTrustsRequest)"> <summary> Obtains information about the trust relationships for this account. <para> If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrusts service method.</param> <returns>The response from the DescribeTrusts service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> The <i>NextToken</i> value is not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DescribeTrustsAsync(Amazon.DirectoryService.Model.DescribeTrustsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTrusts operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrusts operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DisableRadius(Amazon.DirectoryService.Model.DisableRadiusRequest)"> <summary> Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory. </summary> <param name="request">Container for the necessary parameters to execute the DisableRadius service method.</param> <returns>The response from the DisableRadius service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DisableRadiusAsync(Amazon.DirectoryService.Model.DisableRadiusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableRadius operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableRadius operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DisableSso(Amazon.DirectoryService.Model.DisableSsoRequest)"> <summary> Disables single-sign on for a directory. </summary> <param name="request">Container for the necessary parameters to execute the DisableSso service method.</param> <returns>The response from the DisableSso service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.AuthenticationFailedException"> An authentication error occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InsufficientPermissionsException"> The account does not have sufficient permission to perform the operation. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DisableSsoAsync(Amazon.DirectoryService.Model.DisableSsoRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableSso operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableSso operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EnableRadius(Amazon.DirectoryService.Model.EnableRadiusRequest)"> <summary> Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory. </summary> <param name="request">Container for the necessary parameters to execute the EnableRadius service method.</param> <returns>The response from the EnableRadius service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> The specified entity already exists. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EnableRadiusAsync(Amazon.DirectoryService.Model.EnableRadiusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableRadius operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableRadius operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EnableSso(Amazon.DirectoryService.Model.EnableSsoRequest)"> <summary> Enables single-sign on for a directory. </summary> <param name="request">Container for the necessary parameters to execute the EnableSso service method.</param> <returns>The response from the EnableSso service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.AuthenticationFailedException"> An authentication error occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InsufficientPermissionsException"> The account does not have sufficient permission to perform the operation. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EnableSsoAsync(Amazon.DirectoryService.Model.EnableSsoRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableSso operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableSso operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.GetDirectoryLimits"> <summary> Obtains directory limit information for the current region. </summary> <returns>The response from the GetDirectoryLimits service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.GetDirectoryLimits(Amazon.DirectoryService.Model.GetDirectoryLimitsRequest)"> <summary> Obtains directory limit information for the current region. </summary> <param name="request">Container for the necessary parameters to execute the GetDirectoryLimits service method.</param> <returns>The response from the GetDirectoryLimits service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.GetDirectoryLimitsAsync(Amazon.DirectoryService.Model.GetDirectoryLimitsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDirectoryLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDirectoryLimits operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.GetSnapshotLimits(Amazon.DirectoryService.Model.GetSnapshotLimitsRequest)"> <summary> Obtains the manual snapshot limits for a directory. </summary> <param name="request">Container for the necessary parameters to execute the GetSnapshotLimits service method.</param> <returns>The response from the GetSnapshotLimits service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.GetSnapshotLimitsAsync(Amazon.DirectoryService.Model.GetSnapshotLimitsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSnapshotLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSnapshotLimits operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.RegisterEventTopic(Amazon.DirectoryService.Model.RegisterEventTopicRequest)"> <summary> Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status. </summary> <param name="request">Container for the necessary parameters to execute the RegisterEventTopic service method.</param> <returns>The response from the RegisterEventTopic service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.RegisterEventTopicAsync(Amazon.DirectoryService.Model.RegisterEventTopicRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterEventTopic operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterEventTopic operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.RestoreFromSnapshot(Amazon.DirectoryService.Model.RestoreFromSnapshotRequest)"> <summary> Restores a directory using an existing directory snapshot. <para> When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten. </para> <para> This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the <a>DescribeDirectories</a> operation with the directory identifier. When the <b>DirectoryDescription.Stage</b> value changes to <code>Active</code>, the restore operation is complete. </para> </summary> <param name="request">Container for the necessary parameters to execute the RestoreFromSnapshot service method.</param> <returns>The response from the RestoreFromSnapshot service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.RestoreFromSnapshotAsync(Amazon.DirectoryService.Model.RestoreFromSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestoreFromSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreFromSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.UpdateRadius(Amazon.DirectoryService.Model.UpdateRadiusRequest)"> <summary> Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRadius service method.</param> <returns>The response from the UpdateRadius service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.UpdateRadiusAsync(Amazon.DirectoryService.Model.UpdateRadiusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateRadius operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRadius operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.VerifyTrust(Amazon.DirectoryService.Model.VerifyTrustRequest)"> <summary> AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships. <para> This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain. </para> </summary> <param name="request">Container for the necessary parameters to execute the VerifyTrust service method.</param> <returns>The response from the VerifyTrust service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.VerifyTrustAsync(Amazon.DirectoryService.Model.VerifyTrustRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the VerifyTrust operation. </summary> <param name="request">Container for the necessary parameters to execute the VerifyTrust operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.DynamoDBv2.AmazonDynamoDBClient"> <summary> Implementation for accessing DynamoDB Amazon DynamoDB <para> This is the Amazon DynamoDB API Reference. This guide provides descriptions of the low-level DynamoDB API. </para> <para> This guide is intended for use with the following DynamoDB documentation: </para> <ul> <li> <para> <a href="http://docs.aws.amazon.com/amazondynamodb/latest/gettingstartedguide/">Amazon DynamoDB Getting Started Guide</a> - provides hands-on exercises that help you learn the basics of working with DynamoDB. <i>If you are new to DynamoDB, we recommend that you begin with the Getting Started Guide.</i> </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/">Amazon DynamoDB Developer Guide</a> - contains detailed information about DynamoDB concepts, usage, and best practices. </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/dynamodbstreams/latest/APIReference/">Amazon DynamoDB Streams API Reference</a> - provides descriptions and samples of the DynamoDB Streams API. (For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html">Capturing Table Activity with DynamoDB Streams</a> in the Amazon DynamoDB Developer Guide.) </para> </li> </ul> <para> Instead of making the requests to the low-level DynamoDB API directly from your application, we recommend that you use the AWS Software Development Kits (SDKs). The easy-to-use libraries in the AWS SDKs make it unnecessary to call the low-level DynamoDB API directly from your application. The libraries take care of request authentication, serialization, and connection management. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/UsingAWSSDK.html">Using the AWS SDKs with DynamoDB</a> in the Amazon DynamoDB Developer Guide. </para> <para> If you decide to code against the low-level DynamoDB API directly, you will need to write the necessary code to authenticate your requests. For more information on signing your requests, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/API.html">Using the DynamoDB API</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> The following are short descriptions of each low-level API action, organized by function. </para> <para> <b>Managing Tables</b> </para> <ul> <li> <para> <i>CreateTable</i> - Creates a table with user-specified provisioned throughput settings. You must define a primary key for the table - either a simple primary key (partition key), or a composite primary key (partition key and sort key). Optionally, you can create one or more secondary indexes, which provide fast data access using non-key attributes. </para> </li> <li> <para> <i>DescribeTable</i> - Returns metadata for a table, such as table size, status, and index information. </para> </li> <li> <para> <i>UpdateTable</i> - Modifies the provisioned throughput settings for a table. Optionally, you can modify the provisioned throughput settings for global secondary indexes on the table. </para> </li> <li> <para> <i>ListTables</i> - Returns a list of all tables associated with the current AWS account and endpoint. </para> </li> <li> <para> <i>DeleteTable</i> - Deletes a table and all of its indexes. </para> </li> </ul> <para> For conceptual information about managing tables, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html">Working with Tables</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> <b>Reading Data</b> </para> <ul> <li> <para> <i>GetItem</i> - Returns a set of attributes for the item that has a given primary key. By default, <i>GetItem</i> performs an eventually consistent read; however, applications can request a strongly consistent read instead. </para> </li> <li> <para> <i>BatchGetItem</i> - Performs multiple <i>GetItem</i> requests for data items using their primary keys, from one table or multiple tables. The response from <i>BatchGetItem</i> has a size limit of 16 MB and returns a maximum of 100 items. Both eventually consistent and strongly consistent reads can be used. </para> </li> <li> <para> <i>Query</i> - Returns one or more items from a table or a secondary index. You must provide a specific value for the partition key. You can narrow the scope of the query using comparison operators against a sort key value, or on the index key. <i>Query</i> supports either eventual or strong consistency. A single response has a size limit of 1 MB. </para> </li> <li> <para> <i>Scan</i> - Reads every item in a table; the result set is eventually consistent. You can limit the number of items returned by filtering the data attributes, using conditional expressions. <i>Scan</i> can be used to enable ad-hoc querying of a table against non-key attributes; however, since this is a full table scan without using an index, <i>Scan</i> should not be used for any application query use case that requires predictable performance. </para> </li> </ul> <para> For conceptual information about reading data, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> and <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Query and Scan Operations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> <b>Modifying Data</b> </para> <ul> <li> <para> <i>PutItem</i> - Creates a new item, or replaces an existing item with a new item (including all the attributes). By default, if an item in the table already exists with the same primary key, the new item completely replaces the existing item. You can use conditional operators to replace an item only if its attribute values match certain conditions, or to insert a new item only if that item doesn't already exist. </para> </li> <li> <para> <i>UpdateItem</i> - Modifies the attributes of an existing item. You can also use conditional operators to perform an update only if the item's attribute values match certain conditions. </para> </li> <li> <para> <i>DeleteItem</i> - Deletes an item in a table by primary key. You can use conditional operators to perform a delete an item only if the item's attribute values match certain conditions. </para> </li> <li> <para> <i>BatchWriteItem</i> - Performs multiple <i>PutItem</i> and <i>DeleteItem</i> requests across multiple tables in a single request. A failure of any request(s) in the batch will not cause the entire <i>BatchWriteItem</i> operation to fail. Supports batches of up to 25 items to put or delete, with a maximum total request size of 16 MB. </para> </li> </ul> <para> For conceptual information about modifying data, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> and <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Query and Scan Operations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.IAmazonDynamoDB"> <summary> Interface for accessing DynamoDB Amazon DynamoDB <para> This is the Amazon DynamoDB API Reference. This guide provides descriptions of the low-level DynamoDB API. </para> <para> This guide is intended for use with the following DynamoDB documentation: </para> <ul> <li> <para> <a href="http://docs.aws.amazon.com/amazondynamodb/latest/gettingstartedguide/">Amazon DynamoDB Getting Started Guide</a> - provides hands-on exercises that help you learn the basics of working with DynamoDB. <i>If you are new to DynamoDB, we recommend that you begin with the Getting Started Guide.</i> </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/">Amazon DynamoDB Developer Guide</a> - contains detailed information about DynamoDB concepts, usage, and best practices. </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/dynamodbstreams/latest/APIReference/">Amazon DynamoDB Streams API Reference</a> - provides descriptions and samples of the DynamoDB Streams API. (For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html">Capturing Table Activity with DynamoDB Streams</a> in the Amazon DynamoDB Developer Guide.) </para> </li> </ul> <para> Instead of making the requests to the low-level DynamoDB API directly from your application, we recommend that you use the AWS Software Development Kits (SDKs). The easy-to-use libraries in the AWS SDKs make it unnecessary to call the low-level DynamoDB API directly from your application. The libraries take care of request authentication, serialization, and connection management. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/UsingAWSSDK.html">Using the AWS SDKs with DynamoDB</a> in the Amazon DynamoDB Developer Guide. </para> <para> If you decide to code against the low-level DynamoDB API directly, you will need to write the necessary code to authenticate your requests. For more information on signing your requests, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/API.html">Using the DynamoDB API</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> The following are short descriptions of each low-level API action, organized by function. </para> <para> <b>Managing Tables</b> </para> <ul> <li> <para> <i>CreateTable</i> - Creates a table with user-specified provisioned throughput settings. You must define a primary key for the table - either a simple primary key (partition key), or a composite primary key (partition key and sort key). Optionally, you can create one or more secondary indexes, which provide fast data access using non-key attributes. </para> </li> <li> <para> <i>DescribeTable</i> - Returns metadata for a table, such as table size, status, and index information. </para> </li> <li> <para> <i>UpdateTable</i> - Modifies the provisioned throughput settings for a table. Optionally, you can modify the provisioned throughput settings for global secondary indexes on the table. </para> </li> <li> <para> <i>ListTables</i> - Returns a list of all tables associated with the current AWS account and endpoint. </para> </li> <li> <para> <i>DeleteTable</i> - Deletes a table and all of its indexes. </para> </li> </ul> <para> For conceptual information about managing tables, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html">Working with Tables</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> <b>Reading Data</b> </para> <ul> <li> <para> <i>GetItem</i> - Returns a set of attributes for the item that has a given primary key. By default, <i>GetItem</i> performs an eventually consistent read; however, applications can request a strongly consistent read instead. </para> </li> <li> <para> <i>BatchGetItem</i> - Performs multiple <i>GetItem</i> requests for data items using their primary keys, from one table or multiple tables. The response from <i>BatchGetItem</i> has a size limit of 16 MB and returns a maximum of 100 items. Both eventually consistent and strongly consistent reads can be used. </para> </li> <li> <para> <i>Query</i> - Returns one or more items from a table or a secondary index. You must provide a specific value for the partition key. You can narrow the scope of the query using comparison operators against a sort key value, or on the index key. <i>Query</i> supports either eventual or strong consistency. A single response has a size limit of 1 MB. </para> </li> <li> <para> <i>Scan</i> - Reads every item in a table; the result set is eventually consistent. You can limit the number of items returned by filtering the data attributes, using conditional expressions. <i>Scan</i> can be used to enable ad-hoc querying of a table against non-key attributes; however, since this is a full table scan without using an index, <i>Scan</i> should not be used for any application query use case that requires predictable performance. </para> </li> </ul> <para> For conceptual information about reading data, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> and <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Query and Scan Operations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> <b>Modifying Data</b> </para> <ul> <li> <para> <i>PutItem</i> - Creates a new item, or replaces an existing item with a new item (including all the attributes). By default, if an item in the table already exists with the same primary key, the new item completely replaces the existing item. You can use conditional operators to replace an item only if its attribute values match certain conditions, or to insert a new item only if that item doesn't already exist. </para> </li> <li> <para> <i>UpdateItem</i> - Modifies the attributes of an existing item. You can also use conditional operators to perform an update only if the item's attribute values match certain conditions. </para> </li> <li> <para> <i>DeleteItem</i> - Deletes an item in a table by primary key. You can use conditional operators to perform a delete an item only if the item's attribute values match certain conditions. </para> </li> <li> <para> <i>BatchWriteItem</i> - Performs multiple <i>PutItem</i> and <i>DeleteItem</i> requests across multiple tables in a single request. A failure of any request(s) in the batch will not cause the entire <i>BatchWriteItem</i> operation to fail. Supports batches of up to 25 items to put or delete, with a maximum total request size of 16 MB. </para> </li> </ul> <para> For conceptual information about modifying data, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> and <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Query and Scan Operations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BatchGetItem(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.KeysAndAttributes},Amazon.DynamoDBv2.ReturnConsumedCapacity)"> <summary> The <i>BatchGetItem</i> operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. <para> A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. <i>BatchGetItem</i> will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for <i>UnprocessedKeys</i>. You can use this value to retry the operation starting with the next item to get. </para> <important> <para> If you request more than 100 items <i>BatchGetItem</i> will return a <i>ValidationException</i> with the message "Too many items requested for the BatchGetItem call". </para> </important> <para> For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate <i>UnprocessedKeys</i> value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set. </para> <para> If <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchGetItem</i> will return a <i>ProvisionedThroughputExceededException</i>. If <i>at least one</i> of the items is successfully processed, then <i>BatchGetItem</i> completes successfully, while returning the keys of the unread items in <i>UnprocessedKeys</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> By default, <i>BatchGetItem</i> performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set <i>ConsistentRead</i> to <code>true</code> for any or all tables. </para> <para> In order to minimize response latency, <i>BatchGetItem</i> retrieves items in parallel. </para> <para> When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the <i>AttributesToGet</i> parameter. </para> <para> If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations">Capacity Units Calculations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="requestItems">A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per <i>BatchGetItem</i> request. Each element in the map of items to retrieve consists of the following: <ul> <li> <i>ConsistentRead</i> - If <code>true</code>, a strongly consistent read is used; if <code>false</code> (the default), an eventually consistent read is used. </li> <li> <i>ExpressionAttributeNames</i> - One or more substitution tokens for attribute names in the <i>ProjectionExpression</i> parameter. The following are some use cases for using <i>ExpressionAttributeNames</i>: <ul> <li> To access an attribute whose name conflicts with a DynamoDB reserved word. </li> <li> To create a placeholder for repeating occurrences of an attribute name in an expression. </li> <li> To prevent special characters in an attribute name from being misinterpreted in an expression. </li> </ul> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: <ul><li><code>Percentile</code></li></ul> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: <ul><li><code>{"#P":"Percentile"}</code></li></ul> You could then use this substitution in an expression, as in this example: <ul><li><code>#P = :val</code></li></ul> <note>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</note> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>Keys</i> - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide <i>both</i> the partition key value and the sort key value. </li> <li> <i>ProjectionExpression</i> - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>AttributesToGet</i> - <important> This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. </li> </ul></param> <param name="returnConsumedCapacity">A property of BatchGetItemRequest used to execute the BatchGetItem service method.</param> <returns>The response from the BatchGetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BatchGetItem(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.KeysAndAttributes})"> <summary> The <i>BatchGetItem</i> operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. <para> A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. <i>BatchGetItem</i> will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for <i>UnprocessedKeys</i>. You can use this value to retry the operation starting with the next item to get. </para> <important> <para> If you request more than 100 items <i>BatchGetItem</i> will return a <i>ValidationException</i> with the message "Too many items requested for the BatchGetItem call". </para> </important> <para> For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate <i>UnprocessedKeys</i> value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set. </para> <para> If <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchGetItem</i> will return a <i>ProvisionedThroughputExceededException</i>. If <i>at least one</i> of the items is successfully processed, then <i>BatchGetItem</i> completes successfully, while returning the keys of the unread items in <i>UnprocessedKeys</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> By default, <i>BatchGetItem</i> performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set <i>ConsistentRead</i> to <code>true</code> for any or all tables. </para> <para> In order to minimize response latency, <i>BatchGetItem</i> retrieves items in parallel. </para> <para> When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the <i>AttributesToGet</i> parameter. </para> <para> If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations">Capacity Units Calculations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="requestItems">A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per <i>BatchGetItem</i> request. Each element in the map of items to retrieve consists of the following: <ul> <li> <i>ConsistentRead</i> - If <code>true</code>, a strongly consistent read is used; if <code>false</code> (the default), an eventually consistent read is used. </li> <li> <i>ExpressionAttributeNames</i> - One or more substitution tokens for attribute names in the <i>ProjectionExpression</i> parameter. The following are some use cases for using <i>ExpressionAttributeNames</i>: <ul> <li> To access an attribute whose name conflicts with a DynamoDB reserved word. </li> <li> To create a placeholder for repeating occurrences of an attribute name in an expression. </li> <li> To prevent special characters in an attribute name from being misinterpreted in an expression. </li> </ul> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: <ul><li><code>Percentile</code></li></ul> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: <ul><li><code>{"#P":"Percentile"}</code></li></ul> You could then use this substitution in an expression, as in this example: <ul><li><code>#P = :val</code></li></ul> <note>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</note> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>Keys</i> - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide <i>both</i> the partition key value and the sort key value. </li> <li> <i>ProjectionExpression</i> - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>AttributesToGet</i> - <important> This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. </li> </ul></param> <returns>The response from the BatchGetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BatchGetItem(Amazon.DynamoDBv2.Model.BatchGetItemRequest)"> <summary> The <i>BatchGetItem</i> operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. <para> A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. <i>BatchGetItem</i> will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for <i>UnprocessedKeys</i>. You can use this value to retry the operation starting with the next item to get. </para> <important> <para> If you request more than 100 items <i>BatchGetItem</i> will return a <i>ValidationException</i> with the message "Too many items requested for the BatchGetItem call". </para> </important> <para> For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate <i>UnprocessedKeys</i> value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set. </para> <para> If <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchGetItem</i> will return a <i>ProvisionedThroughputExceededException</i>. If <i>at least one</i> of the items is successfully processed, then <i>BatchGetItem</i> completes successfully, while returning the keys of the unread items in <i>UnprocessedKeys</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> By default, <i>BatchGetItem</i> performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set <i>ConsistentRead</i> to <code>true</code> for any or all tables. </para> <para> In order to minimize response latency, <i>BatchGetItem</i> retrieves items in parallel. </para> <para> When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the <i>AttributesToGet</i> parameter. </para> <para> If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations">Capacity Units Calculations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the BatchGetItem service method.</param> <returns>The response from the BatchGetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BatchGetItemAsync(Amazon.DynamoDBv2.Model.BatchGetItemRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchGetItem operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetItem operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BatchWriteItem(System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.WriteRequest}})"> <summary> The <i>BatchWriteItem</i> operation puts or deletes multiple items in one or more tables. A single call to <i>BatchWriteItem</i> can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB. <note> <para> <i>BatchWriteItem</i> cannot update items. To update items, use the <i>UpdateItem</i> API. </para> </note> <para> The individual <i>PutItem</i> and <i>DeleteItem</i> operations specified in <i>BatchWriteItem</i> are atomic; however <i>BatchWriteItem</i> as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the <i>UnprocessedItems</i> response parameter. You can investigate and optionally resend the requests. Typically, you would call <i>BatchWriteItem</i> in a loop. Each iteration would check for unprocessed items and submit a new <i>BatchWriteItem</i> request with those unprocessed items until all items have been processed. </para> <para> Note that if <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchWriteItem</i> will return a <i>ProvisionedThroughputExceededException</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> With <i>BatchWriteItem</i>, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, <i>BatchWriteItem</i> does not behave in the same way as individual <i>PutItem</i> and <i>DeleteItem</i> calls would. For example, you cannot specify conditions on individual put and delete requests, and <i>BatchWriteItem</i> does not return deleted items in the response. </para> <para> If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, <i>BatchWriteItem</i> provides an alternative where the API performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. </para> <para> Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. </para> <para> If one or more of the following is true, DynamoDB rejects the entire batch write operation: </para> <ul> <li> <para> One or more tables specified in the <i>BatchWriteItem</i> request does not exist. </para> </li> <li> <para> Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. </para> </li> <li> <para> You try to perform multiple operations on the same item in the same <i>BatchWriteItem</i> request. For example, you cannot put and delete the same item in the same <i>BatchWriteItem</i> request. </para> </li> <li> <para> There are more than 25 requests in the batch. </para> </li> <li> <para> Any individual item in a batch exceeds 400 KB. </para> </li> <li> <para> The total request size exceeds 16 MB. </para> </li> </ul> </summary> <param name="requestItems">A map of one or more table names and, for each table, a list of operations to be performed (<i>DeleteRequest</i> or <i>PutRequest</i>). Each element in the map consists of the following: <ul> <li> <i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation on the specified item. The item to be deleted is identified by a <i>Key</i> subelement: <ul> <li> <i>Key</i> - A map of primary key attribute values that uniquely identify the ! item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for <i>both</i> the partition key and the sort key. </li> </ul> </li> <li> <i>PutRequest</i> - Perform a <i>PutItem</i> operation on the specified item. The item to be put is identified by an <i>Item</i> subelement: <ul> <li> <i>Item</i> - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a <i>ValidationException</i> exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. </li> </ul> </li> </ul></param> <returns>The response from the BatchWriteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BatchWriteItem(Amazon.DynamoDBv2.Model.BatchWriteItemRequest)"> <summary> The <i>BatchWriteItem</i> operation puts or deletes multiple items in one or more tables. A single call to <i>BatchWriteItem</i> can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB. <note> <para> <i>BatchWriteItem</i> cannot update items. To update items, use the <i>UpdateItem</i> API. </para> </note> <para> The individual <i>PutItem</i> and <i>DeleteItem</i> operations specified in <i>BatchWriteItem</i> are atomic; however <i>BatchWriteItem</i> as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the <i>UnprocessedItems</i> response parameter. You can investigate and optionally resend the requests. Typically, you would call <i>BatchWriteItem</i> in a loop. Each iteration would check for unprocessed items and submit a new <i>BatchWriteItem</i> request with those unprocessed items until all items have been processed. </para> <para> Note that if <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchWriteItem</i> will return a <i>ProvisionedThroughputExceededException</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> With <i>BatchWriteItem</i>, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, <i>BatchWriteItem</i> does not behave in the same way as individual <i>PutItem</i> and <i>DeleteItem</i> calls would. For example, you cannot specify conditions on individual put and delete requests, and <i>BatchWriteItem</i> does not return deleted items in the response. </para> <para> If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, <i>BatchWriteItem</i> provides an alternative where the API performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. </para> <para> Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. </para> <para> If one or more of the following is true, DynamoDB rejects the entire batch write operation: </para> <ul> <li> <para> One or more tables specified in the <i>BatchWriteItem</i> request does not exist. </para> </li> <li> <para> Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. </para> </li> <li> <para> You try to perform multiple operations on the same item in the same <i>BatchWriteItem</i> request. For example, you cannot put and delete the same item in the same <i>BatchWriteItem</i> request. </para> </li> <li> <para> There are more than 25 requests in the batch. </para> </li> <li> <para> Any individual item in a batch exceeds 400 KB. </para> </li> <li> <para> The total request size exceeds 16 MB. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the BatchWriteItem service method.</param> <returns>The response from the BatchWriteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BatchWriteItemAsync(Amazon.DynamoDBv2.Model.BatchWriteItemRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchWriteItem operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchWriteItem operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.CreateTable(System.String,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.KeySchemaElement},System.Collections.Generic.List{Amazon.DynamoDBv2.Model.AttributeDefinition},Amazon.DynamoDBv2.Model.ProvisionedThroughput)"> <summary> The <i>CreateTable</i> operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions. <para> <i>CreateTable</i> is an asynchronous operation. Upon receiving a <i>CreateTable</i> request, DynamoDB immediately returns a response with a <i>TableStatus</i> of <code>CREATING</code>. After the table is created, DynamoDB sets the <i>TableStatus</i> to <code>ACTIVE</code>. You can perform read and write operations only on an <code>ACTIVE</code> table. </para> <para> You can optionally define secondary indexes on the new table, as part of the <i>CreateTable</i> operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the <code>CREATING</code> state at any given time. </para> <para> You can use the <i>DescribeTable</i> API to check the table status. </para> </summary> <param name="tableName">The name of the table to create.</param> <param name="keySchema">Specifies the attributes that make up the primary key for a table or an index. The attributes in <i>KeySchema</i> must also be defined in the <i>AttributeDefinitions</i> array. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html">Data Model</a> in the <i>Amazon DynamoDB Developer Guide</i>. Each <i>KeySchemaElement</i> in the array is composed of: <ul> <li> <i>AttributeName</i> - The name of this key attribute. </li> <li> <i>KeyType</i> - The role that the key attribute will assume: <ul> <li><code>HASH</code> - partition key </li> <li><code>RANGE</code> - sort key</li> </ul> </li> </ul> <note> The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.</note> For a simple primary key (partition key), you must provide exactly one element with a <i>KeyType</i> of <code>HASH</code>. For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a <i>KeyType</i> of <code>HASH</code>, and the second element must have a <i>KeyType</i> of <code>RANGE</code>. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key">Specifying the Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>.</param> <param name="attributeDefinitions">An array of attributes that describe the key schema for the table and indexes.</param> <param name="provisionedThroughput">A property of CreateTableRequest used to execute the CreateTable service method.</param> <returns>The response from the CreateTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.CreateTable(Amazon.DynamoDBv2.Model.CreateTableRequest)"> <summary> The <i>CreateTable</i> operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions. <para> <i>CreateTable</i> is an asynchronous operation. Upon receiving a <i>CreateTable</i> request, DynamoDB immediately returns a response with a <i>TableStatus</i> of <code>CREATING</code>. After the table is created, DynamoDB sets the <i>TableStatus</i> to <code>ACTIVE</code>. You can perform read and write operations only on an <code>ACTIVE</code> table. </para> <para> You can optionally define secondary indexes on the new table, as part of the <i>CreateTable</i> operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the <code>CREATING</code> state at any given time. </para> <para> You can use the <i>DescribeTable</i> API to check the table status. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateTable service method.</param> <returns>The response from the CreateTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.CreateTableAsync(Amazon.DynamoDBv2.Model.CreateTableRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTable operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTable operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DeleteItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value. <para> In addition to deleting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> Unless you specify conditions, the <i>DeleteItem</i> is an idempotent operation; running it multiple times on the same item or attribute does <i>not</i> result in an error response. </para> <para> Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </para> </summary> <param name="tableName">The name of the table from which to delete the item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <returns>The response from the DeleteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DeleteItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},Amazon.DynamoDBv2.ReturnValue)"> <summary> Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value. <para> In addition to deleting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> Unless you specify conditions, the <i>DeleteItem</i> is an idempotent operation; running it multiple times on the same item or attribute does <i>not</i> result in an error response. </para> <para> Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </para> </summary> <param name="tableName">The name of the table from which to delete the item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="returnValues">Use <i>ReturnValues</i> if you want to get the item attributes as they appeared before they were deleted. For <i>DeleteItem</i>, the valid values are: <ul> <li> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </li> <li> <code>ALL_OLD</code> - The content of the old item is returned. </li> </ul></param> <returns>The response from the DeleteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DeleteItem(Amazon.DynamoDBv2.Model.DeleteItemRequest)"> <summary> Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value. <para> In addition to deleting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> Unless you specify conditions, the <i>DeleteItem</i> is an idempotent operation; running it multiple times on the same item or attribute does <i>not</i> result in an error response. </para> <para> Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteItem service method.</param> <returns>The response from the DeleteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DeleteItemAsync(Amazon.DynamoDBv2.Model.DeleteItemRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteItem operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DeleteTable(System.String)"> <summary> The <i>DeleteTable</i> operation deletes a table and all of its items. After a <i>DeleteTable</i> request, the specified table is in the <code>DELETING</code> state until DynamoDB completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete it. If a table is in <code>CREATING</code> or <code>UPDATING</code> states, then DynamoDB returns a <i>ResourceInUseException</i>. If the specified table does not exist, DynamoDB returns a <i>ResourceNotFoundException</i>. If table is already in the <code>DELETING</code> state, no error is returned. <note> <para> DynamoDB might continue to accept data read and write operations, such as <i>GetItem</i> and <i>PutItem</i>, on a table in the <code>DELETING</code> state until the table deletion is complete. </para> </note> <para> When you delete a table, any indexes on that table are also deleted. </para> <para> If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the <code>DISABLED</code> state, and the stream is automatically deleted after 24 hours. </para> <para> Use the <i>DescribeTable</i> API to check the status of the table. </para> </summary> <param name="tableName"> The name of the table to delete.</param> <returns>The response from the DeleteTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DeleteTable(Amazon.DynamoDBv2.Model.DeleteTableRequest)"> <summary> The <i>DeleteTable</i> operation deletes a table and all of its items. After a <i>DeleteTable</i> request, the specified table is in the <code>DELETING</code> state until DynamoDB completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete it. If a table is in <code>CREATING</code> or <code>UPDATING</code> states, then DynamoDB returns a <i>ResourceInUseException</i>. If the specified table does not exist, DynamoDB returns a <i>ResourceNotFoundException</i>. If table is already in the <code>DELETING</code> state, no error is returned. <note> <para> DynamoDB might continue to accept data read and write operations, such as <i>GetItem</i> and <i>PutItem</i>, on a table in the <code>DELETING</code> state until the table deletion is complete. </para> </note> <para> When you delete a table, any indexes on that table are also deleted. </para> <para> If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the <code>DISABLED</code> state, and the stream is automatically deleted after 24 hours. </para> <para> Use the <i>DescribeTable</i> API to check the status of the table. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteTable service method.</param> <returns>The response from the DeleteTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DeleteTableAsync(Amazon.DynamoDBv2.Model.DeleteTableRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTable operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DescribeLimits(Amazon.DynamoDBv2.Model.DescribeLimitsRequest)"> <summary> Returns the current provisioned-capacity limits for your AWS account in a region, both for the region as a whole and for any one DynamoDB table that you create there. <para> When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given region. Also, there are per-table limits that apply when you create a table there. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a> page in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> Although you can increase these limits by filing a case at <a href="https://console.aws.amazon.com/support/home#/">AWS Support Center</a>, obtaining the increase is not instantaneous. The <i>DescribeLimits</i> API lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit. </para> <para> For example, you could use one of the AWS SDKs to do the following: </para> <ol> <li>Call <i>DescribeLimits</i> for a particular region to obtain your current account limits on provisioned capacity there.</li> <li>Create a variable to hold the aggregate read capacity units provisioned for all your tables in that region, and one to hold the aggregate write capacity units. Zero them both.</li> <li>Call <i>ListTables</i> to obtain a list of all your DynamoDB tables.</li> <li> <para> For each table name listed by <i>ListTables</i>, do the following: </para> <ul> <li>Call <i>DescribeTable</i> with the table name.</li> <li>Use the data returned by <i>DescribeTable</i> to add the read capacity units and write capacity units provisioned for the table itself to your variables.</li> <li>If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.</li> </ul> </li> <li>Report the account limits for that region returned by <i>DescribeLimits</i>, along with the total current provisioned capacity levels you have calculated.</li> </ol> <para> This will let you see whether you are getting close to your account-level limits. </para> <para> The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes. </para> <para> For existing tables and their GSIs, DynamoDB will not let you increase provisioned capacity extremely rapidly, but the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits. </para> <note> <para> <i>DescribeLimits</i> should only be called periodically. You can expect throttling errors if you call it more than once in a minute. </para> </note> <para> The <i>DescribeLimits</i> Request element has no content. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLimits service method.</param> <returns>The response from the DescribeLimits service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DescribeLimitsAsync(Amazon.DynamoDBv2.Model.DescribeLimitsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLimits operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DescribeTable(System.String)"> <summary> Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table. <note> <para> If you issue a <i>DescribeTable</i> request immediately after a <i>CreateTable</i> request, DynamoDB might return a <i>ResourceNotFoundException</i>. This is because <i>DescribeTable</i> uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the <i>DescribeTable</i> request again. </para> </note> </summary> <param name="tableName"> The name of the table to describe.</param> <returns>The response from the DescribeTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DescribeTable(Amazon.DynamoDBv2.Model.DescribeTableRequest)"> <summary> Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table. <note> <para> If you issue a <i>DescribeTable</i> request immediately after a <i>CreateTable</i> request, DynamoDB might return a <i>ResourceNotFoundException</i>. This is because <i>DescribeTable</i> uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the <i>DescribeTable</i> request again. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTable service method.</param> <returns>The response from the DescribeTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DescribeTableAsync(Amazon.DynamoDBv2.Model.DescribeTableRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTable operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTable operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.GetItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> The <i>GetItem</i> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <i>GetItem</i> does not return any data. <para> <i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <code>true</code>. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. </para> </summary> <param name="tableName">The name of the table containing the requested item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <returns>The response from the GetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.GetItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},System.Boolean)"> <summary> The <i>GetItem</i> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <i>GetItem</i> does not return any data. <para> <i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <code>true</code>. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. </para> </summary> <param name="tableName">The name of the table containing the requested item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="consistentRead">Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.</param> <returns>The response from the GetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.GetItem(Amazon.DynamoDBv2.Model.GetItemRequest)"> <summary> The <i>GetItem</i> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <i>GetItem</i> does not return any data. <para> <i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <code>true</code>. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetItem service method.</param> <returns>The response from the GetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.GetItemAsync(Amazon.DynamoDBv2.Model.GetItemRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetItem operation. </summary> <param name="request">Container for the necessary parameters to execute the GetItem operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.ListTables"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.ListTables(System.String)"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <param name="exclusiveStartTableName">The first table name that this operation will evaluate. Use the value that was returned for <i>LastEvaluatedTableName</i> in a previous operation, so that you can obtain the next page of results.</param> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.ListTables(System.String,System.Int32)"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <param name="exclusiveStartTableName">The first table name that this operation will evaluate. Use the value that was returned for <i>LastEvaluatedTableName</i> in a previous operation, so that you can obtain the next page of results.</param> <param name="limit"> A maximum number of table names to return. If this parameter is not specified, the limit is 100.</param> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.ListTables(System.Int32)"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <param name="limit"> A maximum number of table names to return. If this parameter is not specified, the limit is 100.</param> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.ListTables(Amazon.DynamoDBv2.Model.ListTablesRequest)"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <param name="request">Container for the necessary parameters to execute the ListTables service method.</param> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.ListTablesAsync(Amazon.DynamoDBv2.Model.ListTablesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTables operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTables operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.PutItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. <para> In addition to putting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. </para> <para> You can request that <i>PutItem</i> return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the <i>ReturnValues</i> description below. </para> <note> <para> To prevent a new item from replacing an existing item, use a conditional expression that contains the <code>attribute_not_exists</code> function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the <code>attribute_not_exists</code> function will only succeed if no matching item exists. </para> </note> <para> For more information about using this API, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="tableName">The name of the table to contain the item.</param> <param name="item">A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey">Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>. Each element in the <i>Item</i> map is an <i>AttributeValue</i> object.</param> <returns>The response from the PutItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.PutItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},Amazon.DynamoDBv2.ReturnValue)"> <summary> Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. <para> In addition to putting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. </para> <para> You can request that <i>PutItem</i> return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the <i>ReturnValues</i> description below. </para> <note> <para> To prevent a new item from replacing an existing item, use a conditional expression that contains the <code>attribute_not_exists</code> function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the <code>attribute_not_exists</code> function will only succeed if no matching item exists. </para> </note> <para> For more information about using this API, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="tableName">The name of the table to contain the item.</param> <param name="item">A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey">Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>. Each element in the <i>Item</i> map is an <i>AttributeValue</i> object.</param> <param name="returnValues">Use <i>ReturnValues</i> if you want to get the item attributes as they appeared before they were updated with the <i>PutItem</i> request. For <i>PutItem</i>, the valid values are: <ul> <li> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </li> <li> <code>ALL_OLD</code> - If <i>PutItem</i> overwrote an attribute name-value pair, then the content of the old item is returned. </li> </ul></param> <returns>The response from the PutItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.PutItem(Amazon.DynamoDBv2.Model.PutItemRequest)"> <summary> Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. <para> In addition to putting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. </para> <para> You can request that <i>PutItem</i> return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the <i>ReturnValues</i> description below. </para> <note> <para> To prevent a new item from replacing an existing item, use a conditional expression that contains the <code>attribute_not_exists</code> function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the <code>attribute_not_exists</code> function will only succeed if no matching item exists. </para> </note> <para> For more information about using this API, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutItem service method.</param> <returns>The response from the PutItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.PutItemAsync(Amazon.DynamoDBv2.Model.PutItemRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutItem operation. </summary> <param name="request">Container for the necessary parameters to execute the PutItem operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.Query(Amazon.DynamoDBv2.Model.QueryRequest)"> <summary> A <i>Query</i> operation uses the primary key of a table or a secondary index to directly access items from that table or index. <para> Use the <i>KeyConditionExpression</i> parameter to provide a specific value for the partition key. The <i>Query</i> operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the <i>Query</i> operation by specifying a sort key value and a comparison operator in <i>KeyConditionExpression</i>. You can use the <i>ScanIndexForward</i> parameter to get results in forward or reverse order, by sort key. </para> <para> Queries that do not return results consume the minimum number of read capacity units for that type of read operation. </para> <para> If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and results are returned to the user with the <i>LastEvaluatedKey</i> element to continue the query in a subsequent operation. Unlike a <i>Scan</i> operation, a <i>Query</i> operation never returns both an empty result set and a <i>LastEvaluatedKey</i> value. <i>LastEvaluatedKey</i> is only provided if the results exceed 1 MB, or if you have used the <i>Limit</i> parameter. </para> <para> You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the <i>ConsistentRead</i> parameter to <code>true</code> and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify <i>ConsistentRead</i> when querying a global secondary index. </para> </summary> <param name="request">Container for the necessary parameters to execute the Query service method.</param> <returns>The response from the Query service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.QueryAsync(Amazon.DynamoDBv2.Model.QueryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Query operation. </summary> <param name="request">Container for the necessary parameters to execute the Query operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.Scan(System.String,System.Collections.Generic.List{System.String})"> <summary> The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> <param name="tableName">The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</param> <param name="attributesToGet"><important>This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.</param> <returns>The response from the Scan service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.Scan(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.Condition})"> <summary> The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> <param name="tableName">The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</param> <param name="scanFilter"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>FilterExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </important> A condition that evaluates the scan results and returns only the desired values. <note>This parameter does not support attributes of type List or Map.</note> If you specify more than one condition in the <i>ScanFilter</i> map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the <i>ConditionalOperator</i> parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) Each <i>ScanFilter</i> element consists of an attribute name to compare, along with the following: <ul> <li> <i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in <i>ComparisonOperator</i> . For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html">JSON Data Format</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> For complete descriptions of all comparison operators, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html">Condition</a>. </li> </ul></param> <returns>The response from the Scan service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.Scan(System.String,System.Collections.Generic.List{System.String},System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.Condition})"> <summary> The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> <param name="tableName">The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</param> <param name="attributesToGet"><important>This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.</param> <param name="scanFilter"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>FilterExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </important> A condition that evaluates the scan results and returns only the desired values. <note>This parameter does not support attributes of type List or Map.</note> If you specify more than one condition in the <i>ScanFilter</i> map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the <i>ConditionalOperator</i> parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) Each <i>ScanFilter</i> element consists of an attribute name to compare, along with the following: <ul> <li> <i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in <i>ComparisonOperator</i> . For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html">JSON Data Format</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> For complete descriptions of all comparison operators, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html">Condition</a>. </li> </ul></param> <returns>The response from the Scan service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.Scan(Amazon.DynamoDBv2.Model.ScanRequest)"> <summary> The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the Scan service method.</param> <returns>The response from the Scan service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.ScanAsync(Amazon.DynamoDBv2.Model.ScanRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Scan operation. </summary> <param name="request">Container for the necessary parameters to execute the Scan operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.UpdateItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValueUpdate})"> <summary> Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values). <para> You can also return the item's attribute values in the same <i>UpdateItem</i> operation using the <i>ReturnValues</i> parameter. </para> </summary> <param name="tableName">The name of the table containing the item to update. </param> <param name="key">The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="attributeUpdates"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>UpdateExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements. </important> The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the <i>AttributesDefinition</i> of the table description. You can use <i>UpdateItem</i> to update any non-key attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. Each <i>AttributeUpdates</i> element consists of an attribute name to modify, along with the following: <ul> <li> <i>Value</i> - The new value, if applicable, for this attribute. </li> <li> <i>Action</i> - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use <code>ADD</code> for other data types. If an item with the specified primary key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </li> <li> <code>DELETE</code> - Removes the attribute and its value, if no value is specified for <code>DELETE</code>. The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>[a,b,c]</code> and the <code>DELETE</code> action specifies <code>[a,c]</code>, then the final attribute value is <code>[b]</code>. Specifying an empty set is an error. </li> <li> <code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute: <ul> <li> If the existing attribute is a number, and if <i>Value</i> is also a number, then <i>Value</i> is mathematically added to the existing attribute. If <i>Value</i> is a negative number, then it is subtracted from the existing attribute. <note> If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <i>itemcount</i>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <i>itemcount</i> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <i>itemcount</i> attribute, with a value of <code>3</code>. </note> </li> <li> If the existing data type is a set, and if <i>Value</i> is also a set, then <i>Value</i> is appended to the existing set. For example, if the attribute value is the set <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then the final attribute value is <code>[1,2,3]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, <i>Value</i> must also be a set of strings. </li> </ul> </li> </ul> If no item with the specified key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute. </li> <li> <code>DELETE</code> - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item. </li> <li> <code>ADD</code> - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set. </li> </ul> </li> </ul> If you provide any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</param> <returns>The response from the UpdateItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.UpdateItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValueUpdate},Amazon.DynamoDBv2.ReturnValue)"> <summary> Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values). <para> You can also return the item's attribute values in the same <i>UpdateItem</i> operation using the <i>ReturnValues</i> parameter. </para> </summary> <param name="tableName">The name of the table containing the item to update. </param> <param name="key">The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="attributeUpdates"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>UpdateExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements. </important> The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the <i>AttributesDefinition</i> of the table description. You can use <i>UpdateItem</i> to update any non-key attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. Each <i>AttributeUpdates</i> element consists of an attribute name to modify, along with the following: <ul> <li> <i>Value</i> - The new value, if applicable, for this attribute. </li> <li> <i>Action</i> - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use <code>ADD</code> for other data types. If an item with the specified primary key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </li> <li> <code>DELETE</code> - Removes the attribute and its value, if no value is specified for <code>DELETE</code>. The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>[a,b,c]</code> and the <code>DELETE</code> action specifies <code>[a,c]</code>, then the final attribute value is <code>[b]</code>. Specifying an empty set is an error. </li> <li> <code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute: <ul> <li> If the existing attribute is a number, and if <i>Value</i> is also a number, then <i>Value</i> is mathematically added to the existing attribute. If <i>Value</i> is a negative number, then it is subtracted from the existing attribute. <note> If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <i>itemcount</i>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <i>itemcount</i> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <i>itemcount</i> attribute, with a value of <code>3</code>. </note> </li> <li> If the existing data type is a set, and if <i>Value</i> is also a set, then <i>Value</i> is appended to the existing set. For example, if the attribute value is the set <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then the final attribute value is <code>[1,2,3]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, <i>Value</i> must also be a set of strings. </li> </ul> </li> </ul> If no item with the specified key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute. </li> <li> <code>DELETE</code> - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item. </li> <li> <code>ADD</code> - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set. </li> </ul> </li> </ul> If you provide any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</param> <param name="returnValues">Use <i>ReturnValues</i> if you want to get the item attributes as they appeared either before or after they were updated. For <i>UpdateItem</i>, the valid values are: <ul> <li> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </li> <li> <code>ALL_OLD</code> - If <i>UpdateItem</i> overwrote an attribute name-value pair, then the content of the old item is returned. </li> <li> <code>UPDATED_OLD</code> - The old versions of only the updated attributes are returned. </li> <li> <code>ALL_NEW</code> - All of the attributes of the new version of the item are returned. </li> <li> <code>UPDATED_NEW</code> - The new versions of only the updated attributes are returned. </li> </ul> There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed. Values returned are strongly consistent</param> <returns>The response from the UpdateItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.UpdateItem(Amazon.DynamoDBv2.Model.UpdateItemRequest)"> <summary> Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values). <para> You can also return the item's attribute values in the same <i>UpdateItem</i> operation using the <i>ReturnValues</i> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateItem service method.</param> <returns>The response from the UpdateItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.UpdateItemAsync(Amazon.DynamoDBv2.Model.UpdateItemRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateItem operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.UpdateTable(System.String,Amazon.DynamoDBv2.Model.ProvisionedThroughput)"> <summary> Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. <para> You can only perform one of the following operations at once: </para> <ul> <li> <para> Modify the provisioned throughput settings of the table. </para> </li> <li> <para> Enable or disable Streams on the table. </para> </li> <li> <para> Remove a global secondary index from the table. </para> </li> <li> <para> Create a new global secondary index on the table. Once the index begins backfilling, you can use <i>UpdateTable</i> to perform other operations. </para> </li> </ul> <para> <i>UpdateTable</i> is an asynchronous operation; while it is executing, the table status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is <code>UPDATING</code>, you cannot issue another <i>UpdateTable</i> request. When the table returns to the <code>ACTIVE</code> state, the <i>UpdateTable</i> operation is complete. </para> </summary> <param name="tableName">The name of the table to be updated.</param> <param name="provisionedThroughput">A property of UpdateTableRequest used to execute the UpdateTable service method.</param> <returns>The response from the UpdateTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.UpdateTable(Amazon.DynamoDBv2.Model.UpdateTableRequest)"> <summary> Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. <para> You can only perform one of the following operations at once: </para> <ul> <li> <para> Modify the provisioned throughput settings of the table. </para> </li> <li> <para> Enable or disable Streams on the table. </para> </li> <li> <para> Remove a global secondary index from the table. </para> </li> <li> <para> Create a new global secondary index on the table. Once the index begins backfilling, you can use <i>UpdateTable</i> to perform other operations. </para> </li> </ul> <para> <i>UpdateTable</i> is an asynchronous operation; while it is executing, the table status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is <code>UPDATING</code>, you cannot issue another <i>UpdateTable</i> request. When the table returns to the <code>ACTIVE</code> state, the <i>UpdateTable</i> operation is complete. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateTable service method.</param> <returns>The response from the UpdateTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.UpdateTableAsync(Amazon.DynamoDBv2.Model.UpdateTableRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateTable operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTable operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor"> <summary> Constructs AmazonDynamoDBClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonDynamoDBClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(Amazon.DynamoDBv2.AmazonDynamoDBConfig)"> <summary> Constructs AmazonDynamoDBClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonDynamoDBClient Configuration Object</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonDynamoDBClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDynamoDBClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.DynamoDBv2.AmazonDynamoDBConfig)"> <summary> Constructs AmazonDynamoDBClient with AWS Credentials and an AmazonDynamoDBClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonDynamoDBClient Configuration Object</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonDynamoDBClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDynamoDBClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(System.String,System.String,Amazon.DynamoDBv2.AmazonDynamoDBConfig)"> <summary> Constructs AmazonDynamoDBClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonDynamoDBClient Configuration Object</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonDynamoDBClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDynamoDBClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(System.String,System.String,System.String,Amazon.DynamoDBv2.AmazonDynamoDBConfig)"> <summary> Constructs AmazonDynamoDBClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonDynamoDBClient Configuration Object</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BatchGetItem(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.KeysAndAttributes},Amazon.DynamoDBv2.ReturnConsumedCapacity)"> <summary> The <i>BatchGetItem</i> operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. <para> A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. <i>BatchGetItem</i> will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for <i>UnprocessedKeys</i>. You can use this value to retry the operation starting with the next item to get. </para> <important> <para> If you request more than 100 items <i>BatchGetItem</i> will return a <i>ValidationException</i> with the message "Too many items requested for the BatchGetItem call". </para> </important> <para> For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate <i>UnprocessedKeys</i> value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set. </para> <para> If <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchGetItem</i> will return a <i>ProvisionedThroughputExceededException</i>. If <i>at least one</i> of the items is successfully processed, then <i>BatchGetItem</i> completes successfully, while returning the keys of the unread items in <i>UnprocessedKeys</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> By default, <i>BatchGetItem</i> performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set <i>ConsistentRead</i> to <code>true</code> for any or all tables. </para> <para> In order to minimize response latency, <i>BatchGetItem</i> retrieves items in parallel. </para> <para> When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the <i>AttributesToGet</i> parameter. </para> <para> If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations">Capacity Units Calculations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="requestItems">A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per <i>BatchGetItem</i> request. Each element in the map of items to retrieve consists of the following: <ul> <li> <i>ConsistentRead</i> - If <code>true</code>, a strongly consistent read is used; if <code>false</code> (the default), an eventually consistent read is used. </li> <li> <i>ExpressionAttributeNames</i> - One or more substitution tokens for attribute names in the <i>ProjectionExpression</i> parameter. The following are some use cases for using <i>ExpressionAttributeNames</i>: <ul> <li> To access an attribute whose name conflicts with a DynamoDB reserved word. </li> <li> To create a placeholder for repeating occurrences of an attribute name in an expression. </li> <li> To prevent special characters in an attribute name from being misinterpreted in an expression. </li> </ul> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: <ul><li><code>Percentile</code></li></ul> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: <ul><li><code>{"#P":"Percentile"}</code></li></ul> You could then use this substitution in an expression, as in this example: <ul><li><code>#P = :val</code></li></ul> <note>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</note> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>Keys</i> - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide <i>both</i> the partition key value and the sort key value. </li> <li> <i>ProjectionExpression</i> - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>AttributesToGet</i> - <important> This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. </li> </ul></param> <param name="returnConsumedCapacity">A property of BatchGetItemRequest used to execute the BatchGetItem service method.</param> <returns>The response from the BatchGetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BatchGetItem(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.KeysAndAttributes})"> <summary> The <i>BatchGetItem</i> operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. <para> A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. <i>BatchGetItem</i> will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for <i>UnprocessedKeys</i>. You can use this value to retry the operation starting with the next item to get. </para> <important> <para> If you request more than 100 items <i>BatchGetItem</i> will return a <i>ValidationException</i> with the message "Too many items requested for the BatchGetItem call". </para> </important> <para> For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate <i>UnprocessedKeys</i> value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set. </para> <para> If <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchGetItem</i> will return a <i>ProvisionedThroughputExceededException</i>. If <i>at least one</i> of the items is successfully processed, then <i>BatchGetItem</i> completes successfully, while returning the keys of the unread items in <i>UnprocessedKeys</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> By default, <i>BatchGetItem</i> performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set <i>ConsistentRead</i> to <code>true</code> for any or all tables. </para> <para> In order to minimize response latency, <i>BatchGetItem</i> retrieves items in parallel. </para> <para> When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the <i>AttributesToGet</i> parameter. </para> <para> If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations">Capacity Units Calculations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="requestItems">A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per <i>BatchGetItem</i> request. Each element in the map of items to retrieve consists of the following: <ul> <li> <i>ConsistentRead</i> - If <code>true</code>, a strongly consistent read is used; if <code>false</code> (the default), an eventually consistent read is used. </li> <li> <i>ExpressionAttributeNames</i> - One or more substitution tokens for attribute names in the <i>ProjectionExpression</i> parameter. The following are some use cases for using <i>ExpressionAttributeNames</i>: <ul> <li> To access an attribute whose name conflicts with a DynamoDB reserved word. </li> <li> To create a placeholder for repeating occurrences of an attribute name in an expression. </li> <li> To prevent special characters in an attribute name from being misinterpreted in an expression. </li> </ul> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: <ul><li><code>Percentile</code></li></ul> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: <ul><li><code>{"#P":"Percentile"}</code></li></ul> You could then use this substitution in an expression, as in this example: <ul><li><code>#P = :val</code></li></ul> <note>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</note> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>Keys</i> - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide <i>both</i> the partition key value and the sort key value. </li> <li> <i>ProjectionExpression</i> - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>AttributesToGet</i> - <important> This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. </li> </ul></param> <returns>The response from the BatchGetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BatchGetItem(Amazon.DynamoDBv2.Model.BatchGetItemRequest)"> <summary> The <i>BatchGetItem</i> operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. <para> A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. <i>BatchGetItem</i> will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for <i>UnprocessedKeys</i>. You can use this value to retry the operation starting with the next item to get. </para> <important> <para> If you request more than 100 items <i>BatchGetItem</i> will return a <i>ValidationException</i> with the message "Too many items requested for the BatchGetItem call". </para> </important> <para> For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate <i>UnprocessedKeys</i> value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set. </para> <para> If <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchGetItem</i> will return a <i>ProvisionedThroughputExceededException</i>. If <i>at least one</i> of the items is successfully processed, then <i>BatchGetItem</i> completes successfully, while returning the keys of the unread items in <i>UnprocessedKeys</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> By default, <i>BatchGetItem</i> performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set <i>ConsistentRead</i> to <code>true</code> for any or all tables. </para> <para> In order to minimize response latency, <i>BatchGetItem</i> retrieves items in parallel. </para> <para> When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the <i>AttributesToGet</i> parameter. </para> <para> If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations">Capacity Units Calculations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the BatchGetItem service method.</param> <returns>The response from the BatchGetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BatchGetItemAsync(Amazon.DynamoDBv2.Model.BatchGetItemRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchGetItem operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetItem operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BatchWriteItem(System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.WriteRequest}})"> <summary> The <i>BatchWriteItem</i> operation puts or deletes multiple items in one or more tables. A single call to <i>BatchWriteItem</i> can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB. <note> <para> <i>BatchWriteItem</i> cannot update items. To update items, use the <i>UpdateItem</i> API. </para> </note> <para> The individual <i>PutItem</i> and <i>DeleteItem</i> operations specified in <i>BatchWriteItem</i> are atomic; however <i>BatchWriteItem</i> as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the <i>UnprocessedItems</i> response parameter. You can investigate and optionally resend the requests. Typically, you would call <i>BatchWriteItem</i> in a loop. Each iteration would check for unprocessed items and submit a new <i>BatchWriteItem</i> request with those unprocessed items until all items have been processed. </para> <para> Note that if <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchWriteItem</i> will return a <i>ProvisionedThroughputExceededException</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> With <i>BatchWriteItem</i>, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, <i>BatchWriteItem</i> does not behave in the same way as individual <i>PutItem</i> and <i>DeleteItem</i> calls would. For example, you cannot specify conditions on individual put and delete requests, and <i>BatchWriteItem</i> does not return deleted items in the response. </para> <para> If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, <i>BatchWriteItem</i> provides an alternative where the API performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. </para> <para> Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. </para> <para> If one or more of the following is true, DynamoDB rejects the entire batch write operation: </para> <ul> <li> <para> One or more tables specified in the <i>BatchWriteItem</i> request does not exist. </para> </li> <li> <para> Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. </para> </li> <li> <para> You try to perform multiple operations on the same item in the same <i>BatchWriteItem</i> request. For example, you cannot put and delete the same item in the same <i>BatchWriteItem</i> request. </para> </li> <li> <para> There are more than 25 requests in the batch. </para> </li> <li> <para> Any individual item in a batch exceeds 400 KB. </para> </li> <li> <para> The total request size exceeds 16 MB. </para> </li> </ul> </summary> <param name="requestItems">A map of one or more table names and, for each table, a list of operations to be performed (<i>DeleteRequest</i> or <i>PutRequest</i>). Each element in the map consists of the following: <ul> <li> <i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation on the specified item. The item to be deleted is identified by a <i>Key</i> subelement: <ul> <li> <i>Key</i> - A map of primary key attribute values that uniquely identify the ! item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for <i>both</i> the partition key and the sort key. </li> </ul> </li> <li> <i>PutRequest</i> - Perform a <i>PutItem</i> operation on the specified item. The item to be put is identified by an <i>Item</i> subelement: <ul> <li> <i>Item</i> - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a <i>ValidationException</i> exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. </li> </ul> </li> </ul></param> <returns>The response from the BatchWriteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BatchWriteItem(Amazon.DynamoDBv2.Model.BatchWriteItemRequest)"> <summary> The <i>BatchWriteItem</i> operation puts or deletes multiple items in one or more tables. A single call to <i>BatchWriteItem</i> can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB. <note> <para> <i>BatchWriteItem</i> cannot update items. To update items, use the <i>UpdateItem</i> API. </para> </note> <para> The individual <i>PutItem</i> and <i>DeleteItem</i> operations specified in <i>BatchWriteItem</i> are atomic; however <i>BatchWriteItem</i> as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the <i>UnprocessedItems</i> response parameter. You can investigate and optionally resend the requests. Typically, you would call <i>BatchWriteItem</i> in a loop. Each iteration would check for unprocessed items and submit a new <i>BatchWriteItem</i> request with those unprocessed items until all items have been processed. </para> <para> Note that if <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchWriteItem</i> will return a <i>ProvisionedThroughputExceededException</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> With <i>BatchWriteItem</i>, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, <i>BatchWriteItem</i> does not behave in the same way as individual <i>PutItem</i> and <i>DeleteItem</i> calls would. For example, you cannot specify conditions on individual put and delete requests, and <i>BatchWriteItem</i> does not return deleted items in the response. </para> <para> If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, <i>BatchWriteItem</i> provides an alternative where the API performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. </para> <para> Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. </para> <para> If one or more of the following is true, DynamoDB rejects the entire batch write operation: </para> <ul> <li> <para> One or more tables specified in the <i>BatchWriteItem</i> request does not exist. </para> </li> <li> <para> Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. </para> </li> <li> <para> You try to perform multiple operations on the same item in the same <i>BatchWriteItem</i> request. For example, you cannot put and delete the same item in the same <i>BatchWriteItem</i> request. </para> </li> <li> <para> There are more than 25 requests in the batch. </para> </li> <li> <para> Any individual item in a batch exceeds 400 KB. </para> </li> <li> <para> The total request size exceeds 16 MB. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the BatchWriteItem service method.</param> <returns>The response from the BatchWriteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BatchWriteItemAsync(Amazon.DynamoDBv2.Model.BatchWriteItemRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchWriteItem operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchWriteItem operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.CreateTable(System.String,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.KeySchemaElement},System.Collections.Generic.List{Amazon.DynamoDBv2.Model.AttributeDefinition},Amazon.DynamoDBv2.Model.ProvisionedThroughput)"> <summary> The <i>CreateTable</i> operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions. <para> <i>CreateTable</i> is an asynchronous operation. Upon receiving a <i>CreateTable</i> request, DynamoDB immediately returns a response with a <i>TableStatus</i> of <code>CREATING</code>. After the table is created, DynamoDB sets the <i>TableStatus</i> to <code>ACTIVE</code>. You can perform read and write operations only on an <code>ACTIVE</code> table. </para> <para> You can optionally define secondary indexes on the new table, as part of the <i>CreateTable</i> operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the <code>CREATING</code> state at any given time. </para> <para> You can use the <i>DescribeTable</i> API to check the table status. </para> </summary> <param name="tableName">The name of the table to create.</param> <param name="keySchema">Specifies the attributes that make up the primary key for a table or an index. The attributes in <i>KeySchema</i> must also be defined in the <i>AttributeDefinitions</i> array. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html">Data Model</a> in the <i>Amazon DynamoDB Developer Guide</i>. Each <i>KeySchemaElement</i> in the array is composed of: <ul> <li> <i>AttributeName</i> - The name of this key attribute. </li> <li> <i>KeyType</i> - The role that the key attribute will assume: <ul> <li><code>HASH</code> - partition key </li> <li><code>RANGE</code> - sort key</li> </ul> </li> </ul> <note> The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.</note> For a simple primary key (partition key), you must provide exactly one element with a <i>KeyType</i> of <code>HASH</code>. For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a <i>KeyType</i> of <code>HASH</code>, and the second element must have a <i>KeyType</i> of <code>RANGE</code>. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key">Specifying the Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>.</param> <param name="attributeDefinitions">An array of attributes that describe the key schema for the table and indexes.</param> <param name="provisionedThroughput">A property of CreateTableRequest used to execute the CreateTable service method.</param> <returns>The response from the CreateTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.CreateTable(Amazon.DynamoDBv2.Model.CreateTableRequest)"> <summary> The <i>CreateTable</i> operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions. <para> <i>CreateTable</i> is an asynchronous operation. Upon receiving a <i>CreateTable</i> request, DynamoDB immediately returns a response with a <i>TableStatus</i> of <code>CREATING</code>. After the table is created, DynamoDB sets the <i>TableStatus</i> to <code>ACTIVE</code>. You can perform read and write operations only on an <code>ACTIVE</code> table. </para> <para> You can optionally define secondary indexes on the new table, as part of the <i>CreateTable</i> operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the <code>CREATING</code> state at any given time. </para> <para> You can use the <i>DescribeTable</i> API to check the table status. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateTable service method.</param> <returns>The response from the CreateTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.CreateTableAsync(Amazon.DynamoDBv2.Model.CreateTableRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTable operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTable operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value. <para> In addition to deleting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> Unless you specify conditions, the <i>DeleteItem</i> is an idempotent operation; running it multiple times on the same item or attribute does <i>not</i> result in an error response. </para> <para> Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </para> </summary> <param name="tableName">The name of the table from which to delete the item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <returns>The response from the DeleteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},Amazon.DynamoDBv2.ReturnValue)"> <summary> Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value. <para> In addition to deleting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> Unless you specify conditions, the <i>DeleteItem</i> is an idempotent operation; running it multiple times on the same item or attribute does <i>not</i> result in an error response. </para> <para> Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </para> </summary> <param name="tableName">The name of the table from which to delete the item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="returnValues">Use <i>ReturnValues</i> if you want to get the item attributes as they appeared before they were deleted. For <i>DeleteItem</i>, the valid values are: <ul> <li> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </li> <li> <code>ALL_OLD</code> - The content of the old item is returned. </li> </ul></param> <returns>The response from the DeleteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteItem(Amazon.DynamoDBv2.Model.DeleteItemRequest)"> <summary> Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value. <para> In addition to deleting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> Unless you specify conditions, the <i>DeleteItem</i> is an idempotent operation; running it multiple times on the same item or attribute does <i>not</i> result in an error response. </para> <para> Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteItem service method.</param> <returns>The response from the DeleteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteItemAsync(Amazon.DynamoDBv2.Model.DeleteItemRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteItem operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteTable(System.String)"> <summary> The <i>DeleteTable</i> operation deletes a table and all of its items. After a <i>DeleteTable</i> request, the specified table is in the <code>DELETING</code> state until DynamoDB completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete it. If a table is in <code>CREATING</code> or <code>UPDATING</code> states, then DynamoDB returns a <i>ResourceInUseException</i>. If the specified table does not exist, DynamoDB returns a <i>ResourceNotFoundException</i>. If table is already in the <code>DELETING</code> state, no error is returned. <note> <para> DynamoDB might continue to accept data read and write operations, such as <i>GetItem</i> and <i>PutItem</i>, on a table in the <code>DELETING</code> state until the table deletion is complete. </para> </note> <para> When you delete a table, any indexes on that table are also deleted. </para> <para> If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the <code>DISABLED</code> state, and the stream is automatically deleted after 24 hours. </para> <para> Use the <i>DescribeTable</i> API to check the status of the table. </para> </summary> <param name="tableName"> The name of the table to delete.</param> <returns>The response from the DeleteTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteTable(Amazon.DynamoDBv2.Model.DeleteTableRequest)"> <summary> The <i>DeleteTable</i> operation deletes a table and all of its items. After a <i>DeleteTable</i> request, the specified table is in the <code>DELETING</code> state until DynamoDB completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete it. If a table is in <code>CREATING</code> or <code>UPDATING</code> states, then DynamoDB returns a <i>ResourceInUseException</i>. If the specified table does not exist, DynamoDB returns a <i>ResourceNotFoundException</i>. If table is already in the <code>DELETING</code> state, no error is returned. <note> <para> DynamoDB might continue to accept data read and write operations, such as <i>GetItem</i> and <i>PutItem</i>, on a table in the <code>DELETING</code> state until the table deletion is complete. </para> </note> <para> When you delete a table, any indexes on that table are also deleted. </para> <para> If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the <code>DISABLED</code> state, and the stream is automatically deleted after 24 hours. </para> <para> Use the <i>DescribeTable</i> API to check the status of the table. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteTable service method.</param> <returns>The response from the DeleteTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteTableAsync(Amazon.DynamoDBv2.Model.DeleteTableRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTable operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DescribeLimits(Amazon.DynamoDBv2.Model.DescribeLimitsRequest)"> <summary> Returns the current provisioned-capacity limits for your AWS account in a region, both for the region as a whole and for any one DynamoDB table that you create there. <para> When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given region. Also, there are per-table limits that apply when you create a table there. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a> page in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> Although you can increase these limits by filing a case at <a href="https://console.aws.amazon.com/support/home#/">AWS Support Center</a>, obtaining the increase is not instantaneous. The <i>DescribeLimits</i> API lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit. </para> <para> For example, you could use one of the AWS SDKs to do the following: </para> <ol> <li>Call <i>DescribeLimits</i> for a particular region to obtain your current account limits on provisioned capacity there.</li> <li>Create a variable to hold the aggregate read capacity units provisioned for all your tables in that region, and one to hold the aggregate write capacity units. Zero them both.</li> <li>Call <i>ListTables</i> to obtain a list of all your DynamoDB tables.</li> <li> <para> For each table name listed by <i>ListTables</i>, do the following: </para> <ul> <li>Call <i>DescribeTable</i> with the table name.</li> <li>Use the data returned by <i>DescribeTable</i> to add the read capacity units and write capacity units provisioned for the table itself to your variables.</li> <li>If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.</li> </ul> </li> <li>Report the account limits for that region returned by <i>DescribeLimits</i>, along with the total current provisioned capacity levels you have calculated.</li> </ol> <para> This will let you see whether you are getting close to your account-level limits. </para> <para> The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes. </para> <para> For existing tables and their GSIs, DynamoDB will not let you increase provisioned capacity extremely rapidly, but the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits. </para> <note> <para> <i>DescribeLimits</i> should only be called periodically. You can expect throttling errors if you call it more than once in a minute. </para> </note> <para> The <i>DescribeLimits</i> Request element has no content. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLimits service method.</param> <returns>The response from the DescribeLimits service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DescribeLimitsAsync(Amazon.DynamoDBv2.Model.DescribeLimitsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLimits operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DescribeTable(System.String)"> <summary> Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table. <note> <para> If you issue a <i>DescribeTable</i> request immediately after a <i>CreateTable</i> request, DynamoDB might return a <i>ResourceNotFoundException</i>. This is because <i>DescribeTable</i> uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the <i>DescribeTable</i> request again. </para> </note> </summary> <param name="tableName"> The name of the table to describe.</param> <returns>The response from the DescribeTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DescribeTable(Amazon.DynamoDBv2.Model.DescribeTableRequest)"> <summary> Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table. <note> <para> If you issue a <i>DescribeTable</i> request immediately after a <i>CreateTable</i> request, DynamoDB might return a <i>ResourceNotFoundException</i>. This is because <i>DescribeTable</i> uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the <i>DescribeTable</i> request again. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTable service method.</param> <returns>The response from the DescribeTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DescribeTableAsync(Amazon.DynamoDBv2.Model.DescribeTableRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTable operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTable operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.GetItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> The <i>GetItem</i> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <i>GetItem</i> does not return any data. <para> <i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <code>true</code>. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. </para> </summary> <param name="tableName">The name of the table containing the requested item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <returns>The response from the GetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.GetItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},System.Boolean)"> <summary> The <i>GetItem</i> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <i>GetItem</i> does not return any data. <para> <i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <code>true</code>. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. </para> </summary> <param name="tableName">The name of the table containing the requested item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="consistentRead">Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.</param> <returns>The response from the GetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.GetItem(Amazon.DynamoDBv2.Model.GetItemRequest)"> <summary> The <i>GetItem</i> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <i>GetItem</i> does not return any data. <para> <i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <code>true</code>. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetItem service method.</param> <returns>The response from the GetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.GetItemAsync(Amazon.DynamoDBv2.Model.GetItemRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetItem operation. </summary> <param name="request">Container for the necessary parameters to execute the GetItem operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.ListTables"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.ListTables(System.String)"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <param name="exclusiveStartTableName">The first table name that this operation will evaluate. Use the value that was returned for <i>LastEvaluatedTableName</i> in a previous operation, so that you can obtain the next page of results.</param> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.ListTables(System.String,System.Int32)"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <param name="exclusiveStartTableName">The first table name that this operation will evaluate. Use the value that was returned for <i>LastEvaluatedTableName</i> in a previous operation, so that you can obtain the next page of results.</param> <param name="limit"> A maximum number of table names to return. If this parameter is not specified, the limit is 100.</param> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.ListTables(System.Int32)"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <param name="limit"> A maximum number of table names to return. If this parameter is not specified, the limit is 100.</param> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.ListTables(Amazon.DynamoDBv2.Model.ListTablesRequest)"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <param name="request">Container for the necessary parameters to execute the ListTables service method.</param> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.ListTablesAsync(Amazon.DynamoDBv2.Model.ListTablesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTables operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTables operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.PutItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. <para> In addition to putting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. </para> <para> You can request that <i>PutItem</i> return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the <i>ReturnValues</i> description below. </para> <note> <para> To prevent a new item from replacing an existing item, use a conditional expression that contains the <code>attribute_not_exists</code> function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the <code>attribute_not_exists</code> function will only succeed if no matching item exists. </para> </note> <para> For more information about using this API, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="tableName">The name of the table to contain the item.</param> <param name="item">A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey">Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>. Each element in the <i>Item</i> map is an <i>AttributeValue</i> object.</param> <returns>The response from the PutItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.PutItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},Amazon.DynamoDBv2.ReturnValue)"> <summary> Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. <para> In addition to putting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. </para> <para> You can request that <i>PutItem</i> return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the <i>ReturnValues</i> description below. </para> <note> <para> To prevent a new item from replacing an existing item, use a conditional expression that contains the <code>attribute_not_exists</code> function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the <code>attribute_not_exists</code> function will only succeed if no matching item exists. </para> </note> <para> For more information about using this API, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="tableName">The name of the table to contain the item.</param> <param name="item">A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey">Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>. Each element in the <i>Item</i> map is an <i>AttributeValue</i> object.</param> <param name="returnValues">Use <i>ReturnValues</i> if you want to get the item attributes as they appeared before they were updated with the <i>PutItem</i> request. For <i>PutItem</i>, the valid values are: <ul> <li> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </li> <li> <code>ALL_OLD</code> - If <i>PutItem</i> overwrote an attribute name-value pair, then the content of the old item is returned. </li> </ul></param> <returns>The response from the PutItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.PutItem(Amazon.DynamoDBv2.Model.PutItemRequest)"> <summary> Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. <para> In addition to putting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. </para> <para> You can request that <i>PutItem</i> return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the <i>ReturnValues</i> description below. </para> <note> <para> To prevent a new item from replacing an existing item, use a conditional expression that contains the <code>attribute_not_exists</code> function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the <code>attribute_not_exists</code> function will only succeed if no matching item exists. </para> </note> <para> For more information about using this API, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutItem service method.</param> <returns>The response from the PutItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.PutItemAsync(Amazon.DynamoDBv2.Model.PutItemRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutItem operation. </summary> <param name="request">Container for the necessary parameters to execute the PutItem operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.Query(Amazon.DynamoDBv2.Model.QueryRequest)"> <summary> A <i>Query</i> operation uses the primary key of a table or a secondary index to directly access items from that table or index. <para> Use the <i>KeyConditionExpression</i> parameter to provide a specific value for the partition key. The <i>Query</i> operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the <i>Query</i> operation by specifying a sort key value and a comparison operator in <i>KeyConditionExpression</i>. You can use the <i>ScanIndexForward</i> parameter to get results in forward or reverse order, by sort key. </para> <para> Queries that do not return results consume the minimum number of read capacity units for that type of read operation. </para> <para> If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and results are returned to the user with the <i>LastEvaluatedKey</i> element to continue the query in a subsequent operation. Unlike a <i>Scan</i> operation, a <i>Query</i> operation never returns both an empty result set and a <i>LastEvaluatedKey</i> value. <i>LastEvaluatedKey</i> is only provided if the results exceed 1 MB, or if you have used the <i>Limit</i> parameter. </para> <para> You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the <i>ConsistentRead</i> parameter to <code>true</code> and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify <i>ConsistentRead</i> when querying a global secondary index. </para> </summary> <param name="request">Container for the necessary parameters to execute the Query service method.</param> <returns>The response from the Query service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.QueryAsync(Amazon.DynamoDBv2.Model.QueryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Query operation. </summary> <param name="request">Container for the necessary parameters to execute the Query operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.Scan(System.String,System.Collections.Generic.List{System.String})"> <summary> The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> <param name="tableName">The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</param> <param name="attributesToGet"><important>This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.</param> <returns>The response from the Scan service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.Scan(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.Condition})"> <summary> The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> <param name="tableName">The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</param> <param name="scanFilter"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>FilterExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </important> A condition that evaluates the scan results and returns only the desired values. <note>This parameter does not support attributes of type List or Map.</note> If you specify more than one condition in the <i>ScanFilter</i> map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the <i>ConditionalOperator</i> parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) Each <i>ScanFilter</i> element consists of an attribute name to compare, along with the following: <ul> <li> <i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in <i>ComparisonOperator</i> . For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html">JSON Data Format</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> For complete descriptions of all comparison operators, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html">Condition</a>. </li> </ul></param> <returns>The response from the Scan service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.Scan(System.String,System.Collections.Generic.List{System.String},System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.Condition})"> <summary> The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> <param name="tableName">The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</param> <param name="attributesToGet"><important>This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.</param> <param name="scanFilter"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>FilterExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </important> A condition that evaluates the scan results and returns only the desired values. <note>This parameter does not support attributes of type List or Map.</note> If you specify more than one condition in the <i>ScanFilter</i> map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the <i>ConditionalOperator</i> parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) Each <i>ScanFilter</i> element consists of an attribute name to compare, along with the following: <ul> <li> <i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in <i>ComparisonOperator</i> . For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html">JSON Data Format</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> For complete descriptions of all comparison operators, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html">Condition</a>. </li> </ul></param> <returns>The response from the Scan service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.Scan(Amazon.DynamoDBv2.Model.ScanRequest)"> <summary> The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the Scan service method.</param> <returns>The response from the Scan service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.ScanAsync(Amazon.DynamoDBv2.Model.ScanRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Scan operation. </summary> <param name="request">Container for the necessary parameters to execute the Scan operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.UpdateItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValueUpdate})"> <summary> Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values). <para> You can also return the item's attribute values in the same <i>UpdateItem</i> operation using the <i>ReturnValues</i> parameter. </para> </summary> <param name="tableName">The name of the table containing the item to update. </param> <param name="key">The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="attributeUpdates"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>UpdateExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements. </important> The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the <i>AttributesDefinition</i> of the table description. You can use <i>UpdateItem</i> to update any non-key attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. Each <i>AttributeUpdates</i> element consists of an attribute name to modify, along with the following: <ul> <li> <i>Value</i> - The new value, if applicable, for this attribute. </li> <li> <i>Action</i> - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use <code>ADD</code> for other data types. If an item with the specified primary key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </li> <li> <code>DELETE</code> - Removes the attribute and its value, if no value is specified for <code>DELETE</code>. The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>[a,b,c]</code> and the <code>DELETE</code> action specifies <code>[a,c]</code>, then the final attribute value is <code>[b]</code>. Specifying an empty set is an error. </li> <li> <code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute: <ul> <li> If the existing attribute is a number, and if <i>Value</i> is also a number, then <i>Value</i> is mathematically added to the existing attribute. If <i>Value</i> is a negative number, then it is subtracted from the existing attribute. <note> If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <i>itemcount</i>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <i>itemcount</i> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <i>itemcount</i> attribute, with a value of <code>3</code>. </note> </li> <li> If the existing data type is a set, and if <i>Value</i> is also a set, then <i>Value</i> is appended to the existing set. For example, if the attribute value is the set <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then the final attribute value is <code>[1,2,3]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, <i>Value</i> must also be a set of strings. </li> </ul> </li> </ul> If no item with the specified key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute. </li> <li> <code>DELETE</code> - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item. </li> <li> <code>ADD</code> - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set. </li> </ul> </li> </ul> If you provide any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</param> <returns>The response from the UpdateItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.UpdateItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValueUpdate},Amazon.DynamoDBv2.ReturnValue)"> <summary> Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values). <para> You can also return the item's attribute values in the same <i>UpdateItem</i> operation using the <i>ReturnValues</i> parameter. </para> </summary> <param name="tableName">The name of the table containing the item to update. </param> <param name="key">The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="attributeUpdates"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>UpdateExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements. </important> The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the <i>AttributesDefinition</i> of the table description. You can use <i>UpdateItem</i> to update any non-key attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. Each <i>AttributeUpdates</i> element consists of an attribute name to modify, along with the following: <ul> <li> <i>Value</i> - The new value, if applicable, for this attribute. </li> <li> <i>Action</i> - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use <code>ADD</code> for other data types. If an item with the specified primary key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </li> <li> <code>DELETE</code> - Removes the attribute and its value, if no value is specified for <code>DELETE</code>. The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>[a,b,c]</code> and the <code>DELETE</code> action specifies <code>[a,c]</code>, then the final attribute value is <code>[b]</code>. Specifying an empty set is an error. </li> <li> <code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute: <ul> <li> If the existing attribute is a number, and if <i>Value</i> is also a number, then <i>Value</i> is mathematically added to the existing attribute. If <i>Value</i> is a negative number, then it is subtracted from the existing attribute. <note> If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <i>itemcount</i>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <i>itemcount</i> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <i>itemcount</i> attribute, with a value of <code>3</code>. </note> </li> <li> If the existing data type is a set, and if <i>Value</i> is also a set, then <i>Value</i> is appended to the existing set. For example, if the attribute value is the set <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then the final attribute value is <code>[1,2,3]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, <i>Value</i> must also be a set of strings. </li> </ul> </li> </ul> If no item with the specified key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute. </li> <li> <code>DELETE</code> - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item. </li> <li> <code>ADD</code> - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set. </li> </ul> </li> </ul> If you provide any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</param> <param name="returnValues">Use <i>ReturnValues</i> if you want to get the item attributes as they appeared either before or after they were updated. For <i>UpdateItem</i>, the valid values are: <ul> <li> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </li> <li> <code>ALL_OLD</code> - If <i>UpdateItem</i> overwrote an attribute name-value pair, then the content of the old item is returned. </li> <li> <code>UPDATED_OLD</code> - The old versions of only the updated attributes are returned. </li> <li> <code>ALL_NEW</code> - All of the attributes of the new version of the item are returned. </li> <li> <code>UPDATED_NEW</code> - The new versions of only the updated attributes are returned. </li> </ul> There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed. Values returned are strongly consistent</param> <returns>The response from the UpdateItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.UpdateItem(Amazon.DynamoDBv2.Model.UpdateItemRequest)"> <summary> Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values). <para> You can also return the item's attribute values in the same <i>UpdateItem</i> operation using the <i>ReturnValues</i> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateItem service method.</param> <returns>The response from the UpdateItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.UpdateItemAsync(Amazon.DynamoDBv2.Model.UpdateItemRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateItem operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.UpdateTable(System.String,Amazon.DynamoDBv2.Model.ProvisionedThroughput)"> <summary> Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. <para> You can only perform one of the following operations at once: </para> <ul> <li> <para> Modify the provisioned throughput settings of the table. </para> </li> <li> <para> Enable or disable Streams on the table. </para> </li> <li> <para> Remove a global secondary index from the table. </para> </li> <li> <para> Create a new global secondary index on the table. Once the index begins backfilling, you can use <i>UpdateTable</i> to perform other operations. </para> </li> </ul> <para> <i>UpdateTable</i> is an asynchronous operation; while it is executing, the table status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is <code>UPDATING</code>, you cannot issue another <i>UpdateTable</i> request. When the table returns to the <code>ACTIVE</code> state, the <i>UpdateTable</i> operation is complete. </para> </summary> <param name="tableName">The name of the table to be updated.</param> <param name="provisionedThroughput">A property of UpdateTableRequest used to execute the UpdateTable service method.</param> <returns>The response from the UpdateTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.UpdateTable(Amazon.DynamoDBv2.Model.UpdateTableRequest)"> <summary> Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. <para> You can only perform one of the following operations at once: </para> <ul> <li> <para> Modify the provisioned throughput settings of the table. </para> </li> <li> <para> Enable or disable Streams on the table. </para> </li> <li> <para> Remove a global secondary index from the table. </para> </li> <li> <para> Create a new global secondary index on the table. Once the index begins backfilling, you can use <i>UpdateTable</i> to perform other operations. </para> </li> </ul> <para> <i>UpdateTable</i> is an asynchronous operation; while it is executing, the table status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is <code>UPDATING</code>, you cannot issue another <i>UpdateTable</i> request. When the table returns to the <code>ACTIVE</code> state, the <i>UpdateTable</i> operation is complete. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateTable service method.</param> <returns>The response from the UpdateTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.UpdateTableAsync(Amazon.DynamoDBv2.Model.UpdateTableRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateTable operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTable operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.DynamoDBv2.DataModel.AsyncSearch`1"> <summary> A strongly-typed object for retrieving search results (Query or Scan) from DynamoDB. </summary> <typeparam name="T"></typeparam> <summary> A strongly-typed object for retrieving search results (Query or Scan) from DynamoDB. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.AsyncSearch`1.GetNextSetAsync(System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution to get the next set of results from DynamoDB. </summary> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns> A Task that can be used to poll or wait for results, or both. Results will include the next set of result items from DynamoDB. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.AsyncSearch`1.GetRemainingAsync(System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution to get all the remaining results from DynamoDB. </summary> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns> A Task that can be used to poll or wait for results, or both. Results will include the remaining result items from DynamoDB. </returns> </member> <member name="P:Amazon.DynamoDBv2.DataModel.AsyncSearch`1.IsDone"> <summary> Flag that, if true, indicates that the search is done </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.BatchGet"> <summary> Represents a non-generic object for retrieving a batch of items from a single DynamoDB table </summary> <summary> Represents a non-generic object for retrieving a batch of items from a single DynamoDB table </summary> <summary> Represents a non-generic object for retrieving a batch of items from a single DynamoDB table </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchGet.ExecuteAsync(System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.BatchGet.Execute"/> </summary> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchGet.Execute"> <summary> Executes a server call to batch-get the items requested. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchGet.ExecuteHelper(System.Boolean)"> <summary> Executes a server call to batch-get the items requested. Populates Results with the retrieved items. </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.BatchGet.Results"> <summary> List of results retrieved from DynamoDB. Populated after Execute is called. </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.BatchGet.ConsistentRead"> <summary> If set to true, a consistent read is issued. Otherwise eventually-consistent is used. </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.MultiTableBatchGet"> <summary> Class for retrieving a batch of items from multiple DynamoDB tables, using multiple strongly-typed BatchGet objects </summary> <summary> Class for retrieving a batch of items from multiple DynamoDB tables, using multiple strongly-typed BatchGet objects </summary> <summary> Class for retrieving a batch of items from multiple DynamoDB tables, using multiple strongly-typed BatchGet objects </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchGet.ExecuteAsync(System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchGet.Execute"/> </summary> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchGet.Execute"> <summary> Executes a multi-table batch request against all configured batches. Results are stored in the respective BatchGet objects. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchGet.#ctor(Amazon.DynamoDBv2.DataModel.BatchGet[])"> <summary> Constructs a MultiTableBatchGet object from a number of BatchGet objects </summary> <param name="batches">Collection of BatchGet objects</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchGet.AddBatch(Amazon.DynamoDBv2.DataModel.BatchGet)"> <summary> Add a BatchGet object to the multi-table batch request </summary> <param name="batch">BatchGet to add</param> </member> <member name="P:Amazon.DynamoDBv2.DataModel.MultiTableBatchGet.TotalKeys"> <summary> Gets the total number of primary keys to be loaded from DynamoDB, across all batches </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.BatchWrite"> <summary> Represents a non-generic object for writing/deleting a batch of items in a single DynamoDB table </summary> <summary> Represents a non-generic object for writing/deleting a batch of items in a single DynamoDB table </summary> <summary> Represents a non-generic object for writing/deleting a batch of items in a single DynamoDB table </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchWrite.ExecuteAsync(System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.BatchWrite.Execute"/> </summary> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchWrite.Execute"> <summary> Executes a server call to batch-write/delete the items requested. If more than 25 put/delete operations are specified, calls of up to 25 put/delete items will be made until all items are processed. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchWrite.ExecuteHelper(System.Boolean)"> <summary> Executes a server call to batch-write/delete the items requested. </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.MultiTableBatchWrite"> <summary> Class for writing/deleting a batch of items in multiple DynamoDB tables, using multiple strongly-typed BatchWrite objects </summary> <summary> Class for writing/deleting a batch of items in multiple DynamoDB tables, using multiple strongly-typed BatchWrite objects </summary> <summary> Class for writing/deleting a batch of items in multiple DynamoDB tables, using multiple strongly-typed BatchWrite objects </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchWrite.ExecuteAsync(System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchWrite.Execute"/> </summary> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchWrite.Execute"> <summary> Executes a multi-table batch request against all configured batches. If more than 25 put/delete operations are specified, calls of up to 25 put/delete items will be made until all items are processed. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchWrite.#ctor(Amazon.DynamoDBv2.DataModel.BatchWrite[])"> <summary> Constructs a MultiTableBatchGet object from a number of BatchGet objects </summary> <param name="batches">Collection of BatchGet objects</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchWrite.AddBatch(Amazon.DynamoDBv2.DataModel.BatchWrite)"> <summary> Add a BatchWrite object to the multi-table batch request </summary> <param name="batch">BatchGet to add</param> </member> <member name="T:Amazon.DynamoDBv2.DataModel.DynamoDBContext"> <summary> Context object for using the DataModel mode of DynamoDB. Used to interact with the service, save/load objects, etc. </summary> <summary> Context object for using the DataModel mode of DynamoDB. Used to interact with the service, save/load objects, etc. </summary> class Context <summary> Context object for using the DataModel mode of DynamoDB. Used to interact with the service, save/load objects, etc. </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.IDynamoDBContext"> <summary> Context interface for using the DataModel mode of DynamoDB. Used to interact with the service, save/load objects, etc. </summary> <summary> Context interface for using the DataModel mode of DynamoDB. Used to interact with the service, save/load objects, etc. </summary> <summary> Context interface for using the DataModel mode of DynamoDB. Used to interact with the service, save/load objects, etc. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.SaveAsync``1(``0,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Save operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Save``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"/> </summary> <typeparam name="T">Type to save as.</typeparam> <param name="value">Object to save.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.SaveAsync``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Save operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Save``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"/> </summary> <typeparam name="T">Type to save as.</typeparam> <param name="value">Object to save.</param> <param name="operationConfig">Overriding configuration.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.LoadAsync``1(System.Object,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object)"/> </summary> <typeparam name="T">Type to populate.</typeparam> <param name="hashKey">Hash key element of the target item.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.LoadAsync``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object)"/> </summary> <typeparam name="T">Type to populate.</typeparam> <param name="hashKey">Hash key element of the target item.</param> <param name="operationConfig">Overriding configuration.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.LoadAsync``1(System.Object,System.Object,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object)"/> </summary> <typeparam name="T">Type to populate.</typeparam> <param name="hashKey">Hash key element of the target item.</param> <param name="rangeKey">Range key element of the target item.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.LoadAsync``1(System.Object,System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object)"/> </summary> <typeparam name="T">Type to populate.</typeparam> <param name="hashKey">Hash key element of the target item.</param> <param name="rangeKey">Range key element of the target item.</param> <param name="operationConfig">Overriding configuration.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.LoadAsync``1(``0,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object)"/> </summary> <typeparam name="T">Type to populate.</typeparam> <param name="keyObject">Key of the target item.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.LoadAsync``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object)"/> </summary> <typeparam name="T">Type to populate.</typeparam> <param name="keyObject">Key of the target item.</param> <param name="operationConfig">Overriding configuration.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.DeleteAsync``1(``0,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <typeparam name="T">Type of object.</typeparam> <param name="value">Object to delete.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.DeleteAsync``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <typeparam name="T">Type of object.</typeparam> <param name="value">Object to delete.</param> <param name="operationConfig">Overriding configuration.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.DeleteAsync``1(System.Object,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKey">Hash key element of the object to delete.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.DeleteAsync``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKey">Hash key element of the object to delete.</param> <param name="operationConfig">Config object which can be used to override that table used.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.DeleteAsync``1(System.Object,System.Object,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKey">Hash key element of the object to delete.</param> <param name="rangeKey">Range key element of the object to delete.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.DeleteAsync``1(System.Object,System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKey">Hash key element of the object to delete.</param> <param name="rangeKey">Range key element of the object to delete.</param> <param name="operationConfig">Config object which can be used to override that table used.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.ExecuteBatchGetAsync(Amazon.DynamoDBv2.DataModel.BatchGet[],System.Threading.CancellationToken)"> <summary> Issues a batch-get request with multiple batches. Results are stored in the individual batches. </summary> <param name="batches"> Configured BatchGet objects </param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.ExecuteBatchWriteAsync(Amazon.DynamoDBv2.DataModel.BatchWrite[],System.Threading.CancellationToken)"> <summary> Issues a batch-write request with multiple batches. </summary> <param name="batches"> Configured BatchWrite objects </param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.ScanAsync``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.DataModel.ScanCondition},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="conditions"> Conditions that the results should meet. </param> <param name="operationConfig">Config object which can be used to override that table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.FromScanAsync``1(Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="scanConfig">Scan request object.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.QueryAsync``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified hash primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.QueryAsync``1(System.Object,Amazon.DynamoDBv2.DocumentModel.QueryOperator,System.Collections.Generic.IEnumerable{System.Object},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified range element condition for a hash-and-range primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <param name="op">Operation of the condition.</param> <param name="values"> Value(s) of the condition. For all operations except QueryOperator.Between, values should be one value. For QueryOperator.Betwee, values should be two values. </param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.FromQueryAsync``1(Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="queryConfig">Query request object.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Save``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Saves an object to DynamoDB using passed-in configs. Passed-in config overrides DynamoDBContextConfig on the context. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type to save as.</typeparam> <param name="value">Object to save.</param> <param name="operationConfig">Overriding configuration.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Load``1(System.Object)"> <summary> Loads an object from DynamoDB for the given hash-and-range primary key and using the given config. Passed-in config overrides DynamoDBContextConfig on the context. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="hashKey">Hash key element of the target item.</param> <returns> Object of type T, populated with properties of item loaded from DynamoDB. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Load``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Loads an object from DynamoDB for the given hash-and-range primary key and using the given config. Passed-in config overrides DynamoDBContextConfig on the context. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="hashKey">Hash key element of the target item.</param> <param name="operationConfig">Overriding configuration.</param> <returns> Object of type T, populated with properties of item loaded from DynamoDB. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Load``1(System.Object,System.Object)"> <summary> Loads an object from DynamoDB for the given hash-and-range primary key and using the given config. Passed-in config overrides DynamoDBContextConfig on the context. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="hashKey">Hash key element of the target item.</param> <param name="rangeKey">Range key element of the target item.</param> <returns> Object of type T, populated with properties of item loaded from DynamoDB. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Load``1(System.Object,System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Loads an object from DynamoDB for the given hash-and-range primary key and using the given config. Passed-in config overrides DynamoDBContextConfig on the context. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="hashKey">Hash key element of the target item.</param> <param name="rangeKey">Range key element of the target item.</param> <param name="operationConfig">Overriding configuration.</param> <returns> Object of type T, populated with properties of item loaded from DynamoDB. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Load``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Loads an object from DynamoDB for the given key and using the given config. The keyObject is a partially-specified instance, where the hash/range properties are equal to the key of the item you want to load. Passed-in config overrides DynamoDBContextConfig on the context. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="keyObject">Key object defining the the target item.</param> <param name="operationConfig">Overriding configuration.</param> <returns> Object of type T, populated with properties of item loaded from DynamoDB. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Delete``1(``0)"> <summary> Deletes an item in DynamoDB corresponding to given object. Passed-in config overrides DynamoDBContextConfig on the context. If SkipVersionCheck=false, will check version of object before deleting. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type of object.</typeparam> <param name="value">Object to delete.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Delete``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Deletes an item in DynamoDB corresponding to given object. Passed-in config overrides DynamoDBContextConfig on the context. If SkipVersionCheck=false, will check version of object before deleting. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type of object.</typeparam> <param name="value">Object to delete.</param> <param name="operationConfig">Overriding configuration.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Delete``1(System.Object)"> <summary> Deletes an item in DynamoDB corresponding to a given hash-and-range primary key. No version check is done prior to delete. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKey">Hash key element of the object to delete.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Delete``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Deletes an item in DynamoDB corresponding to a given hash-and-range primary key. No version check is done prior to delete. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKey">Hash key element of the object to delete.</param> <param name="operationConfig">Config object which can be used to override that table used.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Delete``1(System.Object,System.Object)"> <summary> Deletes an item in DynamoDB corresponding to a given hash-and-range primary key. No version check is done prior to delete. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKey">Hash key element of the object to delete.</param> <param name="rangeKey">Range key element of the object to delete.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Delete``1(System.Object,System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Deletes an item in DynamoDB corresponding to a given hash-and-range primary key. No version check is done prior to delete. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKey">Hash key element of the object to delete.</param> <param name="rangeKey">Range key element of the object to delete.</param> <param name="operationConfig">Config object which can be used to override that table used.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.ExecuteBatchGet(Amazon.DynamoDBv2.DataModel.BatchGet[])"> <summary> Issues a batch-get request with multiple batches. Results are stored in the individual batches. </summary> <param name="batches"> Configured BatchGet objects </param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.CreateBatchGet``1(Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Creates a strongly-typed BatchGet object, allowing a batch-get operation against DynamoDB. </summary> <typeparam name="T">Type of objects to get</typeparam> <param name="operationConfig">Config object which can be used to override that table used.</param> <returns>Empty strongly-typed BatchGet object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.CreateMultiTableBatchGet(Amazon.DynamoDBv2.DataModel.BatchGet[])"> <summary> Creates a MultiTableBatchGet object, composed of multiple individual BatchGet objects. </summary> <param name="batches">Individual BatchGet objects</param> <returns>Composite MultiTableBatchGet object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.ExecuteBatchWrite(Amazon.DynamoDBv2.DataModel.BatchWrite[])"> <summary> Issues a batch-write request with multiple batches. </summary> <param name="batches"> Configured BatchWrite objects </param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.CreateBatchWrite``1(Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Creates a strongly-typed BatchWrite object, allowing a batch-write operation against DynamoDB. </summary> <typeparam name="T">Type of objects to write</typeparam> <param name="operationConfig">Config object which can be used to override that table used.</param> <returns>Empty strongly-typed BatchWrite object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.CreateMultiTableBatchWrite(Amazon.DynamoDBv2.DataModel.BatchWrite[])"> <summary> Creates a MultiTableBatchWrite object, composed of multiple individual BatchWrite objects. </summary> <param name="batches">Individual BatchWrite objects</param> <returns>Composite MultiTableBatchWrite object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Scan``1(Amazon.DynamoDBv2.DataModel.ScanCondition[])"> <summary> Executes a Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="conditions"> Conditions that the results should meet. </param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Scan``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.DataModel.ScanCondition},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Executes a Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="conditions"> Conditions that the results should meet. </param> <param name="operationConfig">Config object which can be used to override that table used.</param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.FromScan``1(Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Executes a Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="scanConfig">Scan request object.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Query``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Executes a Query operation against DynamoDB, finding items that match the specified hash primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Query``1(System.Object,Amazon.DynamoDBv2.DocumentModel.QueryOperator,System.Object[])"> <summary> Executes a Query operation against DynamoDB, finding items that match the specified range element condition for a hash-and-range primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <param name="op">Operation of the condition.</param> <param name="values"> Value(s) of the condition. For all operations except QueryOperator.Between, values should be one value. For QueryOperator.Betwee, values should be two values. </param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Query``1(System.Object,Amazon.DynamoDBv2.DocumentModel.QueryOperator,System.Collections.Generic.IEnumerable{System.Object},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Executes a Query operation against DynamoDB, finding items that match the specified range element condition for a hash-and-range primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <param name="op">Operation of the condition.</param> <param name="values"> Value(s) of the condition. For all operations except QueryOperator.Between, values should be one value. For QueryOperator.Betwee, values should be two values. </param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.FromQuery``1(Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Executes a Query operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="queryConfig">Query request object.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.GetTargetTable``1(Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Retrieves the target table for the specified type </summary> <typeparam name="T">Type to retrieve table for</typeparam> <returns>Table object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.ToDocument``1(``0)"> <summary> Serializes an object to a Document. </summary> <typeparam name="T">Type to serialize as.</typeparam> <param name="value">Object to serialize.</param> <returns>Document with attributes populated from object.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.ToDocument``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Serializes an object to a Document. </summary> <typeparam name="T">Type to serialize as.</typeparam> <param name="value">Object to serialize.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>Document with attributes populated from object.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.FromDocument``1(Amazon.DynamoDBv2.DocumentModel.Document)"> <summary> Deserializes a document to an instance of type T. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="document">Document with properties to use.</param> <returns> Object of type T, populated with properties from the document. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.FromDocument``1(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Deserializes a document to an instance of type T. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="document">Document with properties to use.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns> Object of type T, populated with properties from the document. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.FromDocuments``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.DocumentModel.Document})"> <summary> Deserializes a collections of documents to a collection of instances of type T. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="documents">Documents to deserialize.</param> <returns> Collection of items of type T, each populated with properties from a corresponding document. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.FromDocuments``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.DocumentModel.Document},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Deserializes a collections of documents to a collection of instances of type T. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="documents">Documents to deserialize.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns> Collection of items of type T, each populated with properties from a corresponding document. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.SaveAsync``1(``0,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Save operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Save``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"/> </summary> <typeparam name="T">Type to save as.</typeparam> <param name="value">Object to save.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.SaveAsync``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Save operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Save``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"/> </summary> <typeparam name="T">Type to save as.</typeparam> <param name="value">Object to save.</param> <param name="operationConfig">Overriding configuration.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.LoadAsync``1(System.Object,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object)"/> </summary> <typeparam name="T">Type to populate.</typeparam> <param name="hashKey">Hash key element of the target item.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.LoadAsync``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object)"/> </summary> <typeparam name="T">Type to populate.</typeparam> <param name="hashKey">Hash key element of the target item.</param> <param name="operationConfig">Overriding configuration.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.LoadAsync``1(System.Object,System.Object,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object)"/> </summary> <typeparam name="T">Type to populate.</typeparam> <param name="hashKey">Hash key element of the target item.</param> <param name="rangeKey">Range key element of the target item.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.LoadAsync``1(System.Object,System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object)"/> </summary> <typeparam name="T">Type to populate.</typeparam> <param name="hashKey">Hash key element of the target item.</param> <param name="rangeKey">Range key element of the target item.</param> <param name="operationConfig">Overriding configuration.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.LoadAsync``1(``0,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object)"/> </summary> <typeparam name="T">Type to populate.</typeparam> <param name="keyObject">Key of the target item.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.LoadAsync``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object)"/> </summary> <typeparam name="T">Type to populate.</typeparam> <param name="keyObject">Key of the target item.</param> <param name="operationConfig">Overriding configuration.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.DeleteAsync``1(``0,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <typeparam name="T">Type of object.</typeparam> <param name="value">Object to delete.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.DeleteAsync``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <typeparam name="T">Type of object.</typeparam> <param name="value">Object to delete.</param> <param name="operationConfig">Overriding configuration.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.DeleteAsync``1(System.Object,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKey">Hash key element of the object to delete.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.DeleteAsync``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKey">Hash key element of the object to delete.</param> <param name="operationConfig">Config object which can be used to override that table used.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.DeleteAsync``1(System.Object,System.Object,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKey">Hash key element of the object to delete.</param> <param name="rangeKey">Range key element of the object to delete.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.DeleteAsync``1(System.Object,System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKey">Hash key element of the object to delete.</param> <param name="rangeKey">Range key element of the object to delete.</param> <param name="operationConfig">Config object which can be used to override that table used.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ExecuteBatchGetAsync(Amazon.DynamoDBv2.DataModel.BatchGet[])"> <summary> Issues a batch-get request with multiple batches. Results are stored in the individual batches. </summary> <param name="batches"> Configured BatchGet objects </param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ExecuteBatchGetAsync(Amazon.DynamoDBv2.DataModel.BatchGet[],System.Threading.CancellationToken)"> <summary> Issues a batch-get request with multiple batches. Results are stored in the individual batches. </summary> <param name="batches"> Configured BatchGet objects </param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ExecuteBatchWriteAsync(Amazon.DynamoDBv2.DataModel.BatchWrite[],System.Threading.CancellationToken)"> <summary> Issues a batch-write request with multiple batches. </summary> <param name="batches"> Configured BatchWrite objects </param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ScanAsync``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.DataModel.ScanCondition},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="conditions"> Conditions that the results should meet. </param> <param name="operationConfig">Config object which can be used to override that table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromScanAsync``1(Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="scanConfig">Scan request object.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.QueryAsync``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified hash primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.QueryAsync``1(System.Object,Amazon.DynamoDBv2.DocumentModel.QueryOperator,System.Collections.Generic.IEnumerable{System.Object},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified range element condition for a hash-and-range primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <param name="op">Operation of the condition.</param> <param name="values"> Value(s) of the condition. For all operations except QueryOperator.Between, values should be one value. For QueryOperator.Betwee, values should be two values. </param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromQueryAsync``1(Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="queryConfig">Query request object.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Save``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Saves an object to DynamoDB using passed-in configs. Passed-in config overrides DynamoDBContextConfig on the context. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type to save as.</typeparam> <param name="value">Object to save.</param> <param name="operationConfig">Overriding configuration.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object)"> <summary> Loads an object from DynamoDB for the given hash-and-range primary key and using the given config. Passed-in config overrides DynamoDBContextConfig on the context. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="hashKey">Hash key element of the target item.</param> <returns> Object of type T, populated with properties of item loaded from DynamoDB. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Loads an object from DynamoDB for the given hash-and-range primary key and using the given config. Passed-in config overrides DynamoDBContextConfig on the context. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="hashKey">Hash key element of the target item.</param> <param name="operationConfig">Overriding configuration.</param> <returns> Object of type T, populated with properties of item loaded from DynamoDB. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object,System.Object)"> <summary> Loads an object from DynamoDB for the given hash-and-range primary key and using the given config. Passed-in config overrides DynamoDBContextConfig on the context. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="hashKey">Hash key element of the target item.</param> <param name="rangeKey">Range key element of the target item.</param> <returns> Object of type T, populated with properties of item loaded from DynamoDB. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object,System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Loads an object from DynamoDB for the given hash-and-range primary key and using the given config. Passed-in config overrides DynamoDBContextConfig on the context. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="hashKey">Hash key element of the target item.</param> <param name="rangeKey">Range key element of the target item.</param> <param name="operationConfig">Overriding configuration.</param> <returns> Object of type T, populated with properties of item loaded from DynamoDB. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Loads an object from DynamoDB for the given key and using the given config. The keyObject is a partially-specified instance, where the hash/range properties are equal to the key of the item you want to load. Passed-in config overrides DynamoDBContextConfig on the context. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="keyObject">Key object defining the the target item.</param> <param name="operationConfig">Overriding configuration.</param> <returns> Object of type T, populated with properties of item loaded from DynamoDB. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(``0)"> <summary> Deletes an item in DynamoDB corresponding to given object. Passed-in config overrides DynamoDBContextConfig on the context. If SkipVersionCheck=false, will check version of object before deleting. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type of object.</typeparam> <param name="value">Object to delete.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Deletes an item in DynamoDB corresponding to given object. Passed-in config overrides DynamoDBContextConfig on the context. If SkipVersionCheck=false, will check version of object before deleting. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type of object.</typeparam> <param name="value">Object to delete.</param> <param name="operationConfig">Overriding configuration.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(System.Object)"> <summary> Deletes an item in DynamoDB corresponding to a given hash-and-range primary key. No version check is done prior to delete. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKey">Hash key element of the object to delete.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Deletes an item in DynamoDB corresponding to a given hash-and-range primary key. No version check is done prior to delete. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKey">Hash key element of the object to delete.</param> <param name="operationConfig">Config object which can be used to override that table used.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(System.Object,System.Object)"> <summary> Deletes an item in DynamoDB corresponding to a given hash-and-range primary key. No version check is done prior to delete. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKey">Hash key element of the object to delete.</param> <param name="rangeKey">Range key element of the object to delete.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(System.Object,System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Deletes an item in DynamoDB corresponding to a given hash-and-range primary key. No version check is done prior to delete. Type must be marked up with DynamoDBTableAttribute and at least one public field/property with DynamoDBHashKeyAttribute. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKey">Hash key element of the object to delete.</param> <param name="rangeKey">Range key element of the object to delete.</param> <param name="operationConfig">Config object which can be used to override that table used.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ExecuteBatchGet(Amazon.DynamoDBv2.DataModel.BatchGet[])"> <summary> Issues a batch-get request with multiple batches. Results are stored in the individual batches. </summary> <param name="batches"> Configured BatchGet objects </param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ExecuteBatchWrite(Amazon.DynamoDBv2.DataModel.BatchWrite[])"> <summary> Issues a batch-write request with multiple batches. </summary> <param name="batches"> Configured BatchWrite objects </param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Scan``1(Amazon.DynamoDBv2.DataModel.ScanCondition[])"> <summary> Executes a Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="conditions"> Conditions that the results should meet. </param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Scan``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.DataModel.ScanCondition},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Executes a Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="conditions"> Conditions that the results should meet. </param> <param name="operationConfig">Config object which can be used to override that table used.</param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromScan``1(Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Executes a Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="scanConfig">Scan request object.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Query``1(System.Object)"> <summary> Executes a Query operation against DynamoDB, finding items that match the specified hash primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Query``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Executes a Query operation against DynamoDB, finding items that match the specified hash primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Query``1(System.Object,Amazon.DynamoDBv2.DocumentModel.QueryOperator,System.Object[])"> <summary> Executes a Query operation against DynamoDB, finding items that match the specified range element condition for a hash-and-range primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <param name="op">Operation of the condition.</param> <param name="values"> Value(s) of the condition. For all operations except QueryOperator.Between, values should be one value. For QueryOperator.Betwee, values should be two values. </param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Query``1(System.Object,Amazon.DynamoDBv2.DocumentModel.QueryOperator,System.Collections.Generic.IEnumerable{System.Object},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Executes a Query operation against DynamoDB, finding items that match the specified range element condition for a hash-and-range primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <param name="op">Operation of the condition.</param> <param name="values"> Value(s) of the condition. For all operations except QueryOperator.Between, values should be one value. For QueryOperator.Betwee, values should be two values. </param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromQuery``1(Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig)"> <summary> Executes a Query operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="queryConfig">Query request object.</param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromQuery``1(Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Executes a Query operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="queryConfig">Query request object.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.GetTargetTable``1(Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Retrieves the target table for the specified type </summary> <typeparam name="T">Type to retrieve table for</typeparam> <returns>Table object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.#ctor"> <summary> Constructs a DynamoDBContext object with a default AmazonDynamoDBClient client and a default DynamoDBContextConfig object for configuration. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs a DynamoDBContext object with a default AmazonDynamoDBClient client and a default DynamoDBContextConfig object for configuration. </summary> <param name="region">The region to configure the AmazonDynamoDBClient to use.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.#ctor(Amazon.DynamoDBv2.DataModel.DynamoDBContextConfig)"> <summary> Constructs a DynamoDBContext object with the specified configuration. Uses a default AmazonDynamoDBClient as the client. </summary> <param name="config"></param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.#ctor(Amazon.RegionEndpoint,Amazon.DynamoDBv2.DataModel.DynamoDBContextConfig)"> <summary> Constructs a DynamoDBContext object with the specified configuration. Uses a default AmazonDynamoDBClient as the client. </summary> <param name="region">The region to configure the AmazonDynamoDBClient to use.</param> <param name="config"></param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.#ctor(Amazon.DynamoDBv2.IAmazonDynamoDB)"> <summary> Constructs a DynamoDBContext object with the specified DynamoDB client. Uses default DynamoDBContextConfig object for configuration. </summary> <param name="client">Client to use for making calls</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.#ctor(Amazon.DynamoDBv2.IAmazonDynamoDB,Amazon.DynamoDBv2.DataModel.DynamoDBContextConfig)"> <summary> Constructs a DynamoDBContext object with the specified DynamoDB client and configuration. </summary> <param name="client">Client to use for making calls</param> <param name="config">Configuration to use</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.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.DynamoDBv2.DataModel.DynamoDBContext.Dispose"> <summary> Disposes of all managed and unmanaged resources. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Finalize"> <summary> The destructor for the client class. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.CreateBatchGet``1"> <summary> Creates a strongly-typed BatchGet object, allowing a batch-get operation against DynamoDB. </summary> <typeparam name="T">Type of objects to get</typeparam> <returns>Empty strongly-typed BatchGet object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.CreateBatchGet``1(Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Creates a strongly-typed BatchGet object, allowing a batch-get operation against DynamoDB. </summary> <typeparam name="T">Type of objects to get</typeparam> <param name="operationConfig">Config object which can be used to override that table used.</param> <returns>Empty strongly-typed BatchGet object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.CreateMultiTableBatchGet(Amazon.DynamoDBv2.DataModel.BatchGet[])"> <summary> Creates a MultiTableBatchGet object, composed of multiple individual BatchGet objects. </summary> <param name="batches">Individual BatchGet objects</param> <returns>Composite MultiTableBatchGet object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.CreateBatchWrite``1"> <summary> Creates a strongly-typed BatchWrite object, allowing a batch-write operation against DynamoDB. </summary> <typeparam name="T">Type of objects to write</typeparam> <returns>Empty strongly-typed BatchWrite object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.CreateBatchWrite``1(Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Creates a strongly-typed BatchWrite object, allowing a batch-write operation against DynamoDB. </summary> <typeparam name="T">Type of objects to write</typeparam> <param name="operationConfig">Config object which can be used to override that table used.</param> <returns>Empty strongly-typed BatchWrite object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.CreateMultiTableBatchWrite(Amazon.DynamoDBv2.DataModel.BatchWrite[])"> <summary> Creates a MultiTableBatchWrite object, composed of multiple individual BatchWrite objects. </summary> <param name="batches">Individual BatchWrite objects</param> <returns>Composite MultiTableBatchWrite object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ToDocument``1(``0)"> <summary> Serializes an object to a Document. </summary> <typeparam name="T">Type to serialize as.</typeparam> <param name="value">Object to serialize.</param> <returns>Document with attributes populated from object.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ToDocument``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Serializes an object to a Document. </summary> <typeparam name="T">Type to serialize as.</typeparam> <param name="value">Object to serialize.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>Document with attributes populated from object.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromDocument``1(Amazon.DynamoDBv2.DocumentModel.Document)"> <summary> Deserializes a document to an instance of type T. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="document">Document with properties to use.</param> <returns> Object of type T, populated with properties from the document. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromDocument``1(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Deserializes a document to an instance of type T. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="document">Document with properties to use.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns> Object of type T, populated with properties from the document. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromDocuments``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.DocumentModel.Document})"> <summary> Deserializes a collections of documents to a collection of instances of type T. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="documents">Documents to deserialize.</param> <returns> Collection of items of type T, each populated with properties from a corresponding document. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromDocuments``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.DocumentModel.Document},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Deserializes a collections of documents to a collection of instances of type T. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="documents">Documents to deserialize.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns> Collection of items of type T, each populated with properties from a corresponding document. </returns> </member> <member name="P:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ConverterCache"> <summary> This cache is a way to store Converters for objects which provides a way to expand Context </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet"> <summary> Class for retrieving a batch of Documents from a single DynamoDB table. </summary> <summary> Class for retrieving a batch of Documents from a single DynamoDB table. </summary> <summary> Class for retrieving a batch of Documents from a single DynamoDB table. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.ExecuteAsync(System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.Execute"/> </summary> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.Execute"> <summary> Executes a server call to batch-get the documents requested. Populates Results with the retrieved items. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.#ctor(Amazon.DynamoDBv2.DocumentModel.Table)"> <summary> Constructs a DocumentBatchGet instance for a specific table. </summary> <param name="targetTable">Table to get items from.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.AddKey(Amazon.DynamoDBv2.DocumentModel.Primitive)"> <summary> Add a single item to get, identified by its hash primary key. </summary> <param name="hashKey">Hash key element of the item to get.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.AddKey(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive)"> <summary> Add a single item to get, identified by its hash-and-range primary key. </summary> <param name="hashKey">Hash key element of the item to get.</param> <param name="rangeKey">Range key element of the item to get.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.AddKey(System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry})"> <summary> Add a single item to get, identified by its key. </summary> <param name="key">Key of the item to get.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.Combine(Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet)"> <summary> Creates a MultiTableDocumentBatchGet object that is a combination of the current DocumentBatchGet and the specified DocumentBatchGet. </summary> <param name="otherBatch">Other DocumentBatchGet object.</param> <returns> MultiTableDocumentBatchGet consisting of the two DocumentBatchGet objects. </returns> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.Results"> <summary> List of results retrieved from DynamoDB. Populated after Execute is called. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.AttributesToGet"> <summary> List of attributes to retrieve. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.ConsistentRead"> <summary> If set to true, a consistent read is issued. Otherwise eventually-consistent is used. </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchGet"> <summary> Class for retrieving a batch of Documents from multiple DynamoDB tables. </summary> <summary> Class for retrieving a batch of Documents from multiple DynamoDB tables. </summary> <summary> Class for retrieving a batch of Documents from multiple DynamoDB tables. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchGet.ExecuteAsync(System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchGet.Execute"/> </summary> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchGet.Execute"> <summary> Executes a multi-table batch request against all configured batches. Results are stored in the respective DocumentBatchGet objects. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchGet.#ctor(Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet[])"> <summary> Constructs a MultiTableDocumentBatchGet object from a number of DocumentBatchGet objects. </summary> <param name="batches">Collection of DocumentBatchGet objects.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchGet.AddBatch(Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet)"> <summary> Add a DocumentBatchGet object to the multi-table batch request. </summary> <param name="batch">DocumentBatchGet to add.</param> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchGet.Batches"> <summary> List of DocumentBatchGet objects to include in the multi-table batch request. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchGet.TotalKeys"> <summary> Total number of primary keys in the multi-table batch request. </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite"> <summary> Class for putting and/or deleting a batch of items in a single DynamoDB table. </summary> <summary> Class for putting and/or deleting a batch of items in a single DynamoDB table. </summary> <summary> Class for putting and/or deleting a batch of items in a single DynamoDB table. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite.ExecuteAsync(System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite.Execute"/> </summary> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite.Execute"> <summary> Executes a server call to batch-put/delete the item specified. If more than 25 put/delete operations are specified, calls of up to 25 put/delete items will be made until all items are processed. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite.#ctor(Amazon.DynamoDBv2.DocumentModel.Table)"> <summary> Constructs a DocumentBatchWrite instance for a specific table. </summary> <param name="targetTable">Table to get items from.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite.AddKeyToDelete(Amazon.DynamoDBv2.DocumentModel.Primitive)"> <summary> Add a single item to delete, identified by its hash primary key. </summary> <param name="hashKey">Hash key element of the item to delete.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite.AddKeyToDelete(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive)"> <summary> Add a single item to delete, identified by its hash-and-range primary key. </summary> <param name="hashKey">Hash key element of the item to delete.</param> <param name="rangeKey">Range key element of the item to delete.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite.AddKeyToDelete(System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry})"> <summary> Add a single item to delete, identified by its key. </summary> <param name="key">Key of the item to delete.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite.AddItemToDelete(Amazon.DynamoDBv2.DocumentModel.Document)"> <summary> Add a single item to delete, identified by a Document object. </summary> <param name="document">Document representing the item to be deleted.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite.AddDocumentToPut(Amazon.DynamoDBv2.DocumentModel.Document)"> <summary> Add a single Document to put. </summary> <param name="document">Document to put.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite.Combine(Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite)"> <summary> Creates a MultiTableDocumentBatchWrite object that is a combination of the current DocumentBatchWrite and the specified DocumentBatchWrite. </summary> <param name="otherBatch">Other DocumentBatchWrite object.</param> <returns> MultiTableDocumentBatchWrite consisting of the two DocumentBatchWrite objects. </returns> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchWrite"> <summary> Class for putting and/or deleting a batch of items in multiple DynamoDB tables. </summary> <summary> Class for putting and/or deleting a batch of items in multiple DynamoDB tables. </summary> <summary> Class for putting and/or deleting a batch of items in multiple DynamoDB tables. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchWrite.ExecuteAsync(System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchWrite.Execute"/> </summary> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchWrite.Execute"> <summary> Executes a multi-table batch put/delete against all configured batches. If more than 25 put/delete operations are specified, calls of up to 25 put/delete items will be made until all items are processed. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchWrite.#ctor(Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite[])"> <summary> Constructs a MultiTableDocumentBatchWrite object from a number of DocumentBatchWrite objects. </summary> <param name="batches">Collection of DocumentBatchWrite objects.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchWrite.AddBatch(Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite)"> <summary> Add a DocumentBatchWrite object to the multi-table batch request. </summary> <param name="batch">DocumentBatchWrite to add.</param> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchWrite.Batches"> <summary> List of DocumentBatchWrite objects to include in the multi-table batch request. </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.Search"> <summary> Search response object </summary> <summary> Search response object </summary> <summary> Search response object </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Search.GetNextSetAsync(System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetNextSet operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Search.GetNextSet"/> </summary> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Search.GetRemainingAsync(System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetRemaining operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Search.GetRemaining"/> </summary> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Search.GetNextSet"> <summary> Retrieves the next set (page) of results </summary> <returns>Next set of Documents matching the search parameters</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Search.GetRemaining"> <summary> Retrieves all the remaining results </summary> <returns>List of Documents matching the search parameters</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Search.Reset"> <summary> Resets the Search object to default state. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.TableName"> <summary> Name of the table being searched </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.CollectResults"> <summary> Whether to collect GetNextSet and GetRemaining results in Matches property. Default is true. If set to false, Matches will always be empty. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.Limit"> <summary> Upper limit on the number of items returned. For Queries: upper limit on the number of items returned. For Scan: limit on the number of items scanned. Maps directly to Limit property on Query and Scan operations. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.KeyExpression"> <summary> The key expression that is evaluated for each item of a query. This applies only to Query operations. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.FilterExpression"> <summary> The filter expression that is evaluated for each item. This applies to Query and Scan operations. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.Filter"> <summary> Filter for the search operation This applies to Query and Scan operations. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.ConditionalOperator"> <summary> Conditional operator for the search operation </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.AttributesToGet"> <summary> List of attribute names to retrieve </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.IsConsistentRead"> <summary> Flag that, if true, indicates that the search is operating in consistent-read mode </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.IsBackwardSearch"> <summary> Flag that, if true, indicates that the search is traversing backwards </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.IsDone"> <summary> Flag that, if true, indicates that the search is done </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.NextKey"> <summary> Key denoting the starting point of the next set of results </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.Matches"> <summary> List of currently found items </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.TotalSegments"> <summary> For parallel <i>Scan</i> requests, <i>TotalSegments</i>represents the total number of segments for a table that is being scanned. Segments are a way to logically divide a table into equally sized portions, for the duration of the <i>Scan</i> request. The value of <i>TotalSegments</i> corresponds to the number of application "workers" (such as threads or processes) that will perform the parallel <i>Scan</i>. For example, if you want to scan a table using four application threads, you would specify a <i>TotalSegments</i> value of 4. The value for <i>TotalSegments</i> must be greater than or equal to 1, and less than or equal to 4096. If you specify a <i>TotalSegments</i> value of 1, the <i>Scan</i> will be sequential rather than parallel. If you specify <i>TotalSegments</i>, you must also specify <i>Segment</i>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - 4096</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.Segment"> <summary> For parallel <i>Scan</i> requests, <i>Segment</i> identifies an individual segment to be scanned by an application "worker" (such as a thread or a process). Each worker issues a <i>Scan</i> request with a distinct value for the segment it will scan. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread would specify a <i>Segment</i> value of 0, the second thread would specify 1, and so on. LastEvaluatedKey returned from a parallel scan request must be used with same Segment id in a subsequent operation. The value for <i>Segment</i> must be less than or equal to 0, and less than the value provided for <i>TotalSegments</i>. If you specify <i>Segment</i>, you must also specify <i>TotalSegments</i>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>0 - 4095</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.Count"> <summary> Gets the total number of items that match the search parameters. If IsDone is true and CollectResults is true, returns Matches.Count. Otherwise, makes a call to DynamoDB to find out the number of matching items, without retrieving the items. Count is then cached. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.IndexName"> <summary> Name of the index to query or scan against. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.Select"> <summary> Enum specifying what data to return from query. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.PutItemAsync(Amazon.DynamoDBv2.DocumentModel.Document,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.PutItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.PutItemOperationConfig)"/> </summary> <param name="doc">Document to save.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.PutItemAsync(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.PutItemOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.PutItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.PutItemOperationConfig)"/> </summary> <param name="doc">Document to save.</param> <param name="config">Configuration to use.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItemAsync(Amazon.DynamoDBv2.DocumentModel.Primitive,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItemAsync(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="config">Configuration to use.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItemAsync(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItemAsync(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="config">Configuration to use.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItemAsync(System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig)"/> </summary> <param name="key">Ley of the document.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItemAsync(System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig)"/> </summary> <param name="key">Ley of the document.</param> <param name="config">Configuration to use.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItemAsync(Amazon.DynamoDBv2.DocumentModel.Document,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"/> </summary> <param name="doc">Attributes to update.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItemAsync(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"/> </summary> <param name="doc">Attributes to update.</param> <param name="config">Configuration to use.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItemAsync(Amazon.DynamoDBv2.DocumentModel.Document,System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"/> </summary> <param name="doc">Attributes to update.</param> <param name="key">Key of the document.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItemAsync(Amazon.DynamoDBv2.DocumentModel.Document,System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"/> </summary> <param name="doc">Attributes to update.</param> <param name="key">Key of the document.</param> <param name="config">Configuration to use.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItemAsync(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"/> </summary> <param name="doc">Attributes to update.</param> <param name="hashKey">Hash key element of the document.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItemAsync(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"/> </summary> <param name="doc">Attributes to update.</param> <param name="hashKey">Hash key element of the document.</param> <param name="config">Configuration to use.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItemAsync(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"/> </summary> <param name="doc">Attributes to update.</param> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItemAsync(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"/> </summary> <param name="doc">Attributes to update.</param> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="config">Configuration to use.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItemAsync(Amazon.DynamoDBv2.DocumentModel.Document,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"/> </summary> <param name="document">Document to delete.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItemAsync(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"/> </summary> <param name="document">Document to delete.</param> <param name="config">Configuration to use.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItemAsync(Amazon.DynamoDBv2.DocumentModel.Primitive,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItemAsync(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="config">Configuration to use.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItemAsync(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItemAsync(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="config">Configuration to use.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItemAsync(System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"/> </summary> <param name="key">Key of the document.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItemAsync(System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"/> </summary> <param name="key">Key of the document.</param> <param name="config">Configuration to use.</param> <param name="cancellationToken">Token which can be used to cancel the task.</param> <returns>A Task that can be used to poll or wait for results, or both.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.PutItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.PutItemOperationConfig)"> <summary> Puts a document into DynamoDB, using optional configs. </summary> <param name="doc">Document to save.</param> <param name="config">Configuration to use.</param> <returns>Null or updated attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryPutItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.PutItemOperationConfig)"> <summary> Puts a document into DynamoDB, using optional configs. </summary> <param name="doc">Document to save.</param> <param name="config">Configuration to use.</param> <returns>True if put is successful or false if the condition in the config was not met.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig)"> <summary> Gets a document from DynamoDB by hash primary key, using specified configs. </summary> <param name="hashKey">Hash key element of the document.</param> <param name="config">Configuration to use.</param> <returns>Document from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig)"> <summary> Gets a document from DynamoDB by hash-and-range primary key, using specified configs. </summary> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="config">Configuration to use.</param> <returns>Document from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig)"> <summary> Gets a document from DynamoDB by key, using specified configs. </summary> <param name="key">Key of the document.</param> <param name="config">Configuration to use.</param> <returns>Document from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"> <summary> Update a document in DynamoDB, using specified config. </summary> <param name="doc">Document to update.</param> <param name="config">Configuration to use.</param> <returns>Null or updated attributes, depending on config.</returns> <seealso cref="T:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryUpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"> <summary> Update a document in DynamoDB, using specified config. </summary> <param name="doc">Document to update.</param> <param name="config">Configuration to use.</param> <returns>True if updated or false if the condition in the config was not met.</returns> <seealso cref="T:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"> <summary> Update a document in DynamoDB, with a key to identify the document, and using the specified config. </summary> <param name="doc">Attributes to update.</param> <param name="key">Key of the document.</param> <param name="config">Configuration to use.</param> <returns>Null or updated attributes, depending on config.</returns> <seealso cref="T:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryUpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"> <summary> Update a document in DynamoDB, with a key to identify the document, and using the specified config. </summary> <param name="doc">Attributes to update.</param> <param name="key">Key of the document.</param> <param name="config">Configuration to use.</param> <returns>True if updated or false if the condition in the config was not met.</returns> <seealso cref="T:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"> <summary> Update a document in DynamoDB, with a hash primary key to identify the document, and using the specified config. </summary> <param name="doc">Attributes to update.</param> <param name="hashKey">Hash key element of the document.</param> <param name="config">Configuration to use.</param> <returns>Null or updated attributes, depending on config.</returns> <seealso cref="T:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryUpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"> <summary> Update a document in DynamoDB, with a hash primary key to identify the document, and using the specified config. </summary> <param name="doc">Attributes to update.</param> <param name="hashKey">Hash key element of the document.</param> <param name="config">Configuration to use.</param> <returns>True if updated or false if the condition in the config was not met.</returns> <seealso cref="T:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"> <summary> Update a document in DynamoDB, with a hash-and-range primary key to identify the document, and using the specified config. </summary> <param name="doc">Attributes to update.</param> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="config">Configuration to use.</param> <returns>Null or updated attributes, depending on config.</returns> <seealso cref="T:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryUpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"> <summary> Update a document in DynamoDB, with a hash-and-range primary key to identify the document, and using the specified config. </summary> <param name="doc">Attributes to update.</param> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="config">Configuration to use.</param> <returns>True if updated or false if the condition in the config was not met.</returns> <seealso cref="T:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"> <summary> Delete a document in DynamoDB, using specified configs. </summary> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException">If the condition set on the config fails.</exception> <param name="document">Document to delete.</param> <param name="config">Configuration to use.</param> <returns>Null or old attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryDeleteItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"> <summary> Delete a document in DynamoDB, using specified configs. </summary> <param name="document">Document to delete.</param> <param name="config">Configuration to use.</param> <returns>True if deleted or false if the condition in the config was not met.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"> <summary> Delete a document in DynamoDB, identified by hash-key, using the specified configs. </summary> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException">If the condition set on the config fails.</exception> <param name="hashKey">Hash key element of the document.</param> <param name="config">Configuration to use.</param> <returns>Null or old attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryDeleteItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"> <summary> Delete a document in DynamoDB, identified by a hash primary key, using specified configs. </summary> <param name="hashKey">Hash key element of the document.</param> <param name="config">Configuration to use.</param> <returns>True if deleted or false if the condition in the config was not met.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"> <summary> Delete a document in DynamoDB, identified by hash-and-range primary key, using the specified configs. </summary> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException">If the condition set on the config fails.</exception> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="config">Configuration to use.</param> <returns>Null or old attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryDeleteItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"> <summary> Delete a document in DynamoDB, identified by hash-and-range primary key, using the specified configs. </summary> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="config">Configuration to use.</param> <returns>True if deleted or false if the condition in the config was not met.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"> <summary> Delete a document in DynamoDB, identified by a key, using specified configs. </summary> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException">If the condition set on the config fails.</exception> <param name="key">Key of the document.</param> <param name="config">Configuration to use.</param> <returns>Null or old attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryDeleteItem(System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"> <summary> Delete a document in DynamoDB, identified by a key, using specified configs. </summary> <param name="key">Key of the document.</param> <param name="config">Configuration to use.</param> <returns>True if deleted or false if the condition in the config was not met.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.ValidateConditional(Amazon.DynamoDBv2.DocumentModel.IConditionalOperationConfig)"> <summary> Validates that the conditional properties on the config object are correctly set. </summary> <exception cref="T:System.InvalidOperationException"/> <param name="config"></param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.LoadTable(Amazon.DynamoDBv2.IAmazonDynamoDB,System.String)"> <summary> Creates a Table object with the specified name, using the passed-in client to load the table definition. The returned table will use the conversion specified by AWSConfigs.DynamoDBConfig.ConversionSchema This method will throw an exception if the table does not exist. </summary> <param name="ddbClient">Client to use to access DynamoDB.</param> <param name="tableName">Name of the table.</param> <returns>Table object representing the specified table.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.LoadTable(Amazon.DynamoDBv2.IAmazonDynamoDB,System.String,Amazon.DynamoDBv2.DynamoDBEntryConversion)"> <summary> Creates a Table object with the specified name, using the passed-in client to load the table definition. This method will throw an exception if the table does not exist. </summary> <param name="ddbClient">Client to use to access DynamoDB.</param> <param name="tableName">Name of the table.</param> <param name="conversion">Conversion to use for converting .NET values to DynamoDB values.</param> <returns>Table object representing the specified table.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryLoadTable(Amazon.DynamoDBv2.IAmazonDynamoDB,System.String,Amazon.DynamoDBv2.DocumentModel.Table@)"> <summary> Creates a Table object with the specified name, using the passed-in client to load the table definition. The returned table will use the conversion specified by AWSConfigs.DynamoDBConfig.ConversionSchema This method will return false if the table does not exist. </summary> <param name="ddbClient">Client to use to access DynamoDB.</param> <param name="tableName">Name of the table.</param> <param name="table">Loaded table.</param> <returns> True if table was successfully loaded; otherwise false. </returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryLoadTable(Amazon.DynamoDBv2.IAmazonDynamoDB,System.String,Amazon.DynamoDBv2.DynamoDBEntryConversion,Amazon.DynamoDBv2.DocumentModel.Table@)"> <summary> Creates a Table object with the specified name, using the passed-in client to load the table definition. This method will return false if the table does not exist. </summary> <param name="ddbClient">Client to use to access DynamoDB.</param> <param name="tableName">Name of the table.</param> <param name="conversion">Conversion to use for converting .NET values to DynamoDB values.</param> <param name="table">Loaded table.</param> <returns> True if table was successfully loaded; otherwise false. </returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.Scan(Amazon.DynamoDBv2.DocumentModel.ScanFilter)"> <summary> Initiates a Search object to Scan a DynamoDB table, with the specified filter. No calls are made until the Search object is used. </summary> <param name="filter">Filter to apply to the scan.</param> <returns>Resultant Search container.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.Scan(Amazon.DynamoDBv2.DocumentModel.Expression)"> <summary> Initiates a Search object to Scan a DynamoDB table, with the specified expression. No calls are made until the Search object is used. </summary> <param name="filterExpression">Expression to apply to the scan.</param> <returns>Resultant Search container.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.Scan(Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig)"> <summary> Initiates a Search object to Scan a DynamoDB table, with the specified config. No calls are made until the Search object is used. </summary> <param name="config">Configuration to use.</param> <returns>Resultant Search container.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.Query(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.QueryFilter)"> <summary> Initiates a Search object to Query a DynamoDB table, with the specified hash primary key and filter. No calls are made until the Search object is used. </summary> <param name="hashKey">Value of the hash key for the query operation.</param> <param name="filter">Filter to use.</param> <returns>Resultant Search container.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.Query(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Expression)"> <summary> Initiates a Search object to Query a DynamoDB table, with the specified hash primary key and expression. No calls are made until the Search object is used. </summary> <param name="hashKey">Value of the hash key for the query operation.</param> <param name="filterExpression">Expression to use.</param> <returns>Resultant Search container.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.Query(Amazon.DynamoDBv2.DocumentModel.QueryFilter)"> <summary> Initiates a Search object to Query a DynamoDB table, with the specified filter. No calls are made until the Search object is used. </summary> <param name="filter">Filter to use.</param> <returns>Resultant Search container.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.Query(Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig)"> <summary> Initiates a Search object to Query a DynamoDB table, with the specified config. No calls are made until the Search object is used. </summary> <param name="config">Configuration to use.</param> <returns>Resultant Search container.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.CreateBatchGet"> <summary> Creates a DocumentBatchGet object for the current table, allowing a batch-get operation against DynamoDB. </summary> <returns>Empty DocumentBatchGet object.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.CreateBatchWrite"> <summary> Creates a DocumentBatchWrite object for the current table, allowing a batch-put/delete operation against DynamoDB. </summary> <returns>Empty DocumentBatchWrite object.</returns> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.TableName"> <summary> Name of the table. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.Keys"> <summary> Keys of the table. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.GlobalSecondaryIndexes"> <summary> Global secondary indexes of the table. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.LocalSecondaryIndexes"> <summary> Local secondary indexes of the table. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.LocalSecondaryIndexNames"> <summary> Names of the local secondary indexes of the table. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.GlobalSecondaryIndexNames"> <summary> Names of the global secondary indexes of the table. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.HashKeys"> <summary> List of keys on the table marked HASH </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.RangeKeys"> <summary> List of keys on the table marked RANGE </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.Attributes"> <summary> List of key attributes on the table. </summary> </member> <member name="T:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient"> <summary> Implementation for accessing DynamoDBStreams Amazon DynamoDB Streams <para> This is the Amazon DynamoDB Streams API Reference. This guide describes the low-level API actions for accessing streams and processing stream records. For information about application development with DynamoDB Streams, see the <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide//Streams.html">Amazon DynamoDB Developer Guide</a>. </para> <para> Note that this document is intended for use with the following DynamoDB documentation: </para> <ul> <li> <para> <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/">Amazon DynamoDB Developer Guide</a> </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/">Amazon DynamoDB API Reference</a> </para> </li> </ul> <para> The following are short descriptions of each low-level DynamoDB Streams API action, organized by function. </para> <ul> <li> <para> <i>DescribeStream</i> - Returns detailed information about a particular stream. </para> </li> <li> <para> <i>GetRecords</i> - Retrieves the stream records from within a shard. </para> </li> <li> <para> <i>GetShardIterator</i> - Returns information on how to retrieve the streams record from a shard with a given shard ID. </para> </li> <li> <para> <i>ListStreams</i> - Returns a list of all the streams associated with the current AWS account and endpoint. </para> </li> </ul> </summary> </member> <member name="T:Amazon.DynamoDBv2.IAmazonDynamoDBStreams"> <summary> Interface for accessing DynamoDBStreams Amazon DynamoDB Streams <para> This is the Amazon DynamoDB Streams API Reference. This guide describes the low-level API actions for accessing streams and processing stream records. For information about application development with DynamoDB Streams, see the <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide//Streams.html">Amazon DynamoDB Developer Guide</a>. </para> <para> Note that this document is intended for use with the following DynamoDB documentation: </para> <ul> <li> <para> <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/">Amazon DynamoDB Developer Guide</a> </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/">Amazon DynamoDB API Reference</a> </para> </li> </ul> <para> The following are short descriptions of each low-level DynamoDB Streams API action, organized by function. </para> <ul> <li> <para> <i>DescribeStream</i> - Returns detailed information about a particular stream. </para> </li> <li> <para> <i>GetRecords</i> - Retrieves the stream records from within a shard. </para> </li> <li> <para> <i>GetShardIterator</i> - Returns information on how to retrieve the streams record from a shard with a given shard ID. </para> </li> <li> <para> <i>ListStreams</i> - Returns a list of all the streams associated with the current AWS account and endpoint. </para> </li> </ul> </summary> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.DescribeStream(System.String)"> <summary> Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table. <note> <para> You can call <i>DescribeStream</i> at a maximum rate of 10 times per second. </para> </note> <para> Each shard in the stream has a <code>SequenceNumberRange</code> associated with it. If the <code>SequenceNumberRange</code> has a <code>StartingSequenceNumber</code> but no <code>EndingSequenceNumber</code>, then the shard is still open (able to receive more stream records). If both <code>StartingSequenceNumber</code> and <code>EndingSequenceNumber</code> are present, the that shared is closed and can no longer receive more data. </para> </summary> <param name="streamArn">The Amazon Resource Name (ARN) for the stream.</param> <returns>The response from the DescribeStream service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.DescribeStream(Amazon.DynamoDBv2.Model.DescribeStreamRequest)"> <summary> Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table. <note> <para> You can call <i>DescribeStream</i> at a maximum rate of 10 times per second. </para> </note> <para> Each shard in the stream has a <code>SequenceNumberRange</code> associated with it. If the <code>SequenceNumberRange</code> has a <code>StartingSequenceNumber</code> but no <code>EndingSequenceNumber</code>, then the shard is still open (able to receive more stream records). If both <code>StartingSequenceNumber</code> and <code>EndingSequenceNumber</code> are present, the that shared is closed and can no longer receive more data. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStream service method.</param> <returns>The response from the DescribeStream service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.DescribeStreamAsync(Amazon.DynamoDBv2.Model.DescribeStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStream operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.GetRecords(System.String)"> <summary> Retrieves the stream records from a given shard. <para> Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, <code>GetRecords</code> returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records. </para> <note> <para> GetRecords can retrieve a maximum of 1 MB of data or 2000 stream records, whichever comes first. </para> </note> </summary> <param name="shardIterator">A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.</param> <returns>The response from the GetRecords service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ExpiredIteratorException"> The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the <i>GetShardIterator</i> action. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.TrimmedDataAccessException"> The operation attempted to read past the oldest stream record in a shard. <para> In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if: </para> <ul> <li>You request a shard iterator with a sequence number older than the trim point (24 hours).</li> <li>You obtain a shard iterator, but before you use the iterator in a <i>GetRecords</i> request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.</li> </ul> </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.GetRecords(Amazon.DynamoDBv2.Model.GetRecordsRequest)"> <summary> Retrieves the stream records from a given shard. <para> Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, <code>GetRecords</code> returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records. </para> <note> <para> GetRecords can retrieve a maximum of 1 MB of data or 2000 stream records, whichever comes first. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the GetRecords service method.</param> <returns>The response from the GetRecords service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ExpiredIteratorException"> The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the <i>GetShardIterator</i> action. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.TrimmedDataAccessException"> The operation attempted to read past the oldest stream record in a shard. <para> In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if: </para> <ul> <li>You request a shard iterator with a sequence number older than the trim point (24 hours).</li> <li>You obtain a shard iterator, but before you use the iterator in a <i>GetRecords</i> request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.</li> </ul> </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.GetRecordsAsync(Amazon.DynamoDBv2.Model.GetRecordsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetRecords operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRecords operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.GetShardIterator(Amazon.DynamoDBv2.Model.GetShardIteratorRequest)"> <summary> Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent <code>GetRecords</code> request to read the stream records from the shard. <note> <para> A shard iterator expires 15 minutes after it is returned to the requester. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the GetShardIterator service method.</param> <returns>The response from the GetShardIterator service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.TrimmedDataAccessException"> The operation attempted to read past the oldest stream record in a shard. <para> In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if: </para> <ul> <li>You request a shard iterator with a sequence number older than the trim point (24 hours).</li> <li>You obtain a shard iterator, but before you use the iterator in a <i>GetRecords</i> request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.</li> </ul> </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.GetShardIteratorAsync(Amazon.DynamoDBv2.Model.GetShardIteratorRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetShardIterator operation. </summary> <param name="request">Container for the necessary parameters to execute the GetShardIterator operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.ListStreams"> <summary> Returns an array of stream ARNs associated with the current account and endpoint. If the <code>TableName</code> parameter is present, then <i>ListStreams</i> will return only the streams ARNs for that table. <note> <para> You can call <i>ListStreams</i> at a maximum rate of 5 times per second. </para> </note> </summary> <returns>The response from the ListStreams service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.ListStreams(Amazon.DynamoDBv2.Model.ListStreamsRequest)"> <summary> Returns an array of stream ARNs associated with the current account and endpoint. If the <code>TableName</code> parameter is present, then <i>ListStreams</i> will return only the streams ARNs for that table. <note> <para> You can call <i>ListStreams</i> at a maximum rate of 5 times per second. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ListStreams service method.</param> <returns>The response from the ListStreams service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.ListStreamsAsync(Amazon.DynamoDBv2.Model.ListStreamsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListStreams operation. </summary> <param name="request">Container for the necessary parameters to execute the ListStreams operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor"> <summary> Constructs AmazonDynamoDBStreamsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonDynamoDBStreamsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(Amazon.DynamoDBv2.AmazonDynamoDBStreamsConfig)"> <summary> Constructs AmazonDynamoDBStreamsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonDynamoDBStreamsClient Configuration Object</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.DynamoDBv2.AmazonDynamoDBStreamsConfig)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Credentials and an AmazonDynamoDBStreamsClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonDynamoDBStreamsClient Configuration Object</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(System.String,System.String,Amazon.DynamoDBv2.AmazonDynamoDBStreamsConfig)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBStreamsClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonDynamoDBStreamsClient Configuration Object</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(System.String,System.String,System.String,Amazon.DynamoDBv2.AmazonDynamoDBStreamsConfig)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBStreamsClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonDynamoDBStreamsClient Configuration Object</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.DescribeStream(System.String)"> <summary> Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table. <note> <para> You can call <i>DescribeStream</i> at a maximum rate of 10 times per second. </para> </note> <para> Each shard in the stream has a <code>SequenceNumberRange</code> associated with it. If the <code>SequenceNumberRange</code> has a <code>StartingSequenceNumber</code> but no <code>EndingSequenceNumber</code>, then the shard is still open (able to receive more stream records). If both <code>StartingSequenceNumber</code> and <code>EndingSequenceNumber</code> are present, the that shared is closed and can no longer receive more data. </para> </summary> <param name="streamArn">The Amazon Resource Name (ARN) for the stream.</param> <returns>The response from the DescribeStream service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.DescribeStream(Amazon.DynamoDBv2.Model.DescribeStreamRequest)"> <summary> Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table. <note> <para> You can call <i>DescribeStream</i> at a maximum rate of 10 times per second. </para> </note> <para> Each shard in the stream has a <code>SequenceNumberRange</code> associated with it. If the <code>SequenceNumberRange</code> has a <code>StartingSequenceNumber</code> but no <code>EndingSequenceNumber</code>, then the shard is still open (able to receive more stream records). If both <code>StartingSequenceNumber</code> and <code>EndingSequenceNumber</code> are present, the that shared is closed and can no longer receive more data. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStream service method.</param> <returns>The response from the DescribeStream service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.DescribeStreamAsync(Amazon.DynamoDBv2.Model.DescribeStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStream operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.GetRecords(System.String)"> <summary> Retrieves the stream records from a given shard. <para> Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, <code>GetRecords</code> returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records. </para> <note> <para> GetRecords can retrieve a maximum of 1 MB of data or 2000 stream records, whichever comes first. </para> </note> </summary> <param name="shardIterator">A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.</param> <returns>The response from the GetRecords service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ExpiredIteratorException"> The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the <i>GetShardIterator</i> action. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.TrimmedDataAccessException"> The operation attempted to read past the oldest stream record in a shard. <para> In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if: </para> <ul> <li>You request a shard iterator with a sequence number older than the trim point (24 hours).</li> <li>You obtain a shard iterator, but before you use the iterator in a <i>GetRecords</i> request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.</li> </ul> </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.GetRecords(Amazon.DynamoDBv2.Model.GetRecordsRequest)"> <summary> Retrieves the stream records from a given shard. <para> Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, <code>GetRecords</code> returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records. </para> <note> <para> GetRecords can retrieve a maximum of 1 MB of data or 2000 stream records, whichever comes first. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the GetRecords service method.</param> <returns>The response from the GetRecords service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ExpiredIteratorException"> The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the <i>GetShardIterator</i> action. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.TrimmedDataAccessException"> The operation attempted to read past the oldest stream record in a shard. <para> In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if: </para> <ul> <li>You request a shard iterator with a sequence number older than the trim point (24 hours).</li> <li>You obtain a shard iterator, but before you use the iterator in a <i>GetRecords</i> request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.</li> </ul> </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.GetRecordsAsync(Amazon.DynamoDBv2.Model.GetRecordsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetRecords operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRecords operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.GetShardIterator(Amazon.DynamoDBv2.Model.GetShardIteratorRequest)"> <summary> Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent <code>GetRecords</code> request to read the stream records from the shard. <note> <para> A shard iterator expires 15 minutes after it is returned to the requester. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the GetShardIterator service method.</param> <returns>The response from the GetShardIterator service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.TrimmedDataAccessException"> The operation attempted to read past the oldest stream record in a shard. <para> In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if: </para> <ul> <li>You request a shard iterator with a sequence number older than the trim point (24 hours).</li> <li>You obtain a shard iterator, but before you use the iterator in a <i>GetRecords</i> request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.</li> </ul> </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.GetShardIteratorAsync(Amazon.DynamoDBv2.Model.GetShardIteratorRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetShardIterator operation. </summary> <param name="request">Container for the necessary parameters to execute the GetShardIterator operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.ListStreams"> <summary> Returns an array of stream ARNs associated with the current account and endpoint. If the <code>TableName</code> parameter is present, then <i>ListStreams</i> will return only the streams ARNs for that table. <note> <para> You can call <i>ListStreams</i> at a maximum rate of 5 times per second. </para> </note> </summary> <returns>The response from the ListStreams service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.ListStreams(Amazon.DynamoDBv2.Model.ListStreamsRequest)"> <summary> Returns an array of stream ARNs associated with the current account and endpoint. If the <code>TableName</code> parameter is present, then <i>ListStreams</i> will return only the streams ARNs for that table. <note> <para> You can call <i>ListStreams</i> at a maximum rate of 5 times per second. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ListStreams service method.</param> <returns>The response from the ListStreams service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.ListStreamsAsync(Amazon.DynamoDBv2.Model.ListStreamsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListStreams operation. </summary> <param name="request">Container for the necessary parameters to execute the ListStreams operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.EC2.AmazonEC2Client"> <summary> Implementation for accessing EC2 Amazon Elastic Compute Cloud <para> Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster. </para> </summary> <summary> Implementation for accessing AmazonEC2. <para> Amazon Elastic Compute Cloud (Amazon EC2) is a web service that provides resizable compute capacity in the cloud. It is designed to make web-scale computing easier for developers. </para> <para> Amazon EC2's simple web service interface allows you to obtain and configure capacity with minimal friction. It provides you with complete control of your computing resources and lets you run on Amazon's proven computing environment. Amazon EC2 reduces the time required to obtain and boot new server instances to minutes, allowing you to quickly scale capacity, both up and down, as your computing requirements change. Amazon EC2 changes the economics of computing by allowing you to pay only for capacity that you actually use. Amazon EC2 provides developers the tools to build failure resilient applications and isolate themselves from common failure scenarios. </para> <para> Visit http://aws.amazon.com/ec2/ for more information. </para> </summary> </member> <member name="T:Amazon.EC2.IAmazonEC2"> <summary> Interface for accessing EC2 Amazon Elastic Compute Cloud <para> Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster. </para> </summary> </member> <member name="M:Amazon.EC2.IAmazonEC2.AcceptVpcPeeringConnection(Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest)"> <summary> Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the <code>pending-acceptance</code> state, and you must be the owner of the peer VPC. Use the <code>DescribeVpcPeeringConnections</code> request to view your outstanding VPC peering connection requests. </summary> <param name="request">Container for the necessary parameters to execute the AcceptVpcPeeringConnection service method.</param> <returns>The response from the AcceptVpcPeeringConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AcceptVpcPeeringConnectionAsync(Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AcceptVpcPeeringConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the AcceptVpcPeeringConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AllocateAddress"> <summary> Acquires an Elastic IP address. <para> An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the AllocateAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AllocateAddress(Amazon.EC2.Model.AllocateAddressRequest)"> <summary> Acquires an Elastic IP address. <para> An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AllocateAddress service method.</param> <returns>The response from the AllocateAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AllocateAddressAsync(Amazon.EC2.Model.AllocateAddressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AllocateAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the AllocateAddress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AssignPrivateIpAddresses(Amazon.EC2.Model.AssignPrivateIpAddressesRequest)"> <summary> Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about Elastic IP addresses, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> AssignPrivateIpAddresses is available only in EC2-VPC. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssignPrivateIpAddresses service method.</param> <returns>The response from the AssignPrivateIpAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AssignPrivateIpAddressesAsync(Amazon.EC2.Model.AssignPrivateIpAddressesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssignPrivateIpAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the AssignPrivateIpAddresses operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AssociateAddress(Amazon.EC2.Model.AssociateAddressRequest)"> <summary> Associates an Elastic IP address with an instance or a network interface. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> [EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. </para> <para> [VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. </para> <para> This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssociateAddress service method.</param> <returns>The response from the AssociateAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AssociateAddressAsync(Amazon.EC2.Model.AssociateAddressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssociateAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the AssociateAddress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AssociateDhcpOptions(Amazon.EC2.Model.AssociateDhcpOptionsRequest)"> <summary> Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC. <para> After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssociateDhcpOptions service method.</param> <returns>The response from the AssociateDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AssociateDhcpOptionsAsync(Amazon.EC2.Model.AssociateDhcpOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssociateDhcpOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the AssociateDhcpOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AssociateRouteTable(Amazon.EC2.Model.AssociateRouteTableRequest)"> <summary> Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssociateRouteTable service method.</param> <returns>The response from the AssociateRouteTable service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AssociateRouteTableAsync(Amazon.EC2.Model.AssociateRouteTableRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssociateRouteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the AssociateRouteTable operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AttachClassicLinkVpc(Amazon.EC2.Model.AttachClassicLinkVpcRequest)"> <summary> Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the <code>running</code> state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it. <para> After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again. </para> <para> Linking your instance to a VPC is sometimes referred to as <i>attaching</i> your instance. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachClassicLinkVpc service method.</param> <returns>The response from the AttachClassicLinkVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AttachClassicLinkVpcAsync(Amazon.EC2.Model.AttachClassicLinkVpcRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachClassicLinkVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachClassicLinkVpc operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AttachInternetGateway(Amazon.EC2.Model.AttachInternetGatewayRequest)"> <summary> Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/">Amazon Virtual Private Cloud User Guide</a>. </summary> <param name="request">Container for the necessary parameters to execute the AttachInternetGateway service method.</param> <returns>The response from the AttachInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AttachInternetGatewayAsync(Amazon.EC2.Model.AttachInternetGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachInternetGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachInternetGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AttachNetworkInterface(Amazon.EC2.Model.AttachNetworkInterfaceRequest)"> <summary> Attaches a network interface to an instance. </summary> <param name="request">Container for the necessary parameters to execute the AttachNetworkInterface service method.</param> <returns>The response from the AttachNetworkInterface service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AttachNetworkInterfaceAsync(Amazon.EC2.Model.AttachNetworkInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachNetworkInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachNetworkInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AttachVolume(Amazon.EC2.Model.AttachVolumeRequest)"> <summary> Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. <para> Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For a list of supported device names, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html">Attaching an EBS Volume to an Instance</a>. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html">Amazon EC2 Instance Store</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> If a volume has an AWS Marketplace product code: </para> <ul> <li>The volume can be attached only to a stopped instance.</li> <li>AWS Marketplace product codes are copied from the volume to the instance.</li> <li>You must be subscribed to the product.</li> <li>The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.</li> </ul> <para> For an overview of the AWS Marketplace, see <a href="https://aws.amazon.com/marketplace/help/200900000">Introducing AWS Marketplace</a>. </para> <para> For more information about EBS volumes, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html">Attaching Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachVolume service method.</param> <returns>The response from the AttachVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AttachVolumeAsync(Amazon.EC2.Model.AttachVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AttachVpnGateway(Amazon.EC2.Model.AttachVpnGatewayRequest)"> <summary> Attaches a virtual private gateway to a VPC. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the AttachVpnGateway service method.</param> <returns>The response from the AttachVpnGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AttachVpnGatewayAsync(Amazon.EC2.Model.AttachVpnGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachVpnGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachVpnGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AuthorizeSecurityGroupEgress(Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest)"> <summary> Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC. <important> <para> You can have up to 50 rules per security group (covering both ingress and egress rules). </para> </important> <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <para> Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes. </para> <para> Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur. </para> </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSecurityGroupEgress service method.</param> <returns>The response from the AuthorizeSecurityGroupEgress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AuthorizeSecurityGroupEgressAsync(Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AuthorizeSecurityGroupEgress operation. </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSecurityGroupEgress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AuthorizeSecurityGroupIngress(Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest)"> <summary> Adds one or more ingress rules to a security group. <important> <para> EC2-Classic: You can have up to 100 rules per group. </para> <para> EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules). </para> </important> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> <para> [EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the <i>source groups</i>) permission to access a security group for your account. A source group can be for your own AWS account, or another. </para> <para> [EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the <i>source groups</i>) permission to access a security group for your VPC. The security groups must all be for the same VPC. </para> </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSecurityGroupIngress service method.</param> <returns>The response from the AuthorizeSecurityGroupIngress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AuthorizeSecurityGroupIngressAsync(Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AuthorizeSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSecurityGroupIngress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BundleInstance(Amazon.EC2.Model.BundleInstanceRequest)"> <summary> Bundles an Amazon instance store-backed Windows instance. <para> During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved. </para> <note> <para> This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS. </para> </note> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/Creating_InstanceStoreBacked_WinAMI.html">Creating an Instance Store-Backed Windows AMI</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the BundleInstance service method.</param> <returns>The response from the BundleInstance service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BundleInstanceAsync(Amazon.EC2.Model.BundleInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BundleInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the BundleInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelBundleTask(Amazon.EC2.Model.CancelBundleTaskRequest)"> <summary> Cancels a bundling operation for an instance store-backed Windows instance. </summary> <param name="request">Container for the necessary parameters to execute the CancelBundleTask service method.</param> <returns>The response from the CancelBundleTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelBundleTaskAsync(Amazon.EC2.Model.CancelBundleTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelBundleTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelBundleTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelConversionTask(Amazon.EC2.Model.CancelConversionTaskRequest)"> <summary> Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CancelConversionTask service method.</param> <returns>The response from the CancelConversionTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelConversionTaskAsync(Amazon.EC2.Model.CancelConversionTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelConversionTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelConversionTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelExportTask(Amazon.EC2.Model.CancelExportTaskRequest)"> <summary> Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error. </summary> <param name="request">Container for the necessary parameters to execute the CancelExportTask service method.</param> <returns>The response from the CancelExportTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelExportTaskAsync(Amazon.EC2.Model.CancelExportTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelExportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelExportTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelImportTask(Amazon.EC2.Model.CancelImportTaskRequest)"> <summary> Cancels an in-process import virtual machine or import snapshot task. </summary> <param name="request">Container for the necessary parameters to execute the CancelImportTask service method.</param> <returns>The response from the CancelImportTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelImportTaskAsync(Amazon.EC2.Model.CancelImportTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelImportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelImportTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelReservedInstancesListing(Amazon.EC2.Model.CancelReservedInstancesListingRequest)"> <summary> Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CancelReservedInstancesListing service method.</param> <returns>The response from the CancelReservedInstancesListing service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelReservedInstancesListingAsync(Amazon.EC2.Model.CancelReservedInstancesListingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelReservedInstancesListing operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelReservedInstancesListing operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelSpotFleetRequests(Amazon.EC2.Model.CancelSpotFleetRequestsRequest)"> <summary> Cancels the specified Spot fleet requests. </summary> <param name="request">Container for the necessary parameters to execute the CancelSpotFleetRequests service method.</param> <returns>The response from the CancelSpotFleetRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelSpotFleetRequestsAsync(Amazon.EC2.Model.CancelSpotFleetRequestsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelSpotFleetRequests operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelSpotFleetRequests operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelSpotInstanceRequests(Amazon.EC2.Model.CancelSpotInstanceRequestsRequest)"> <summary> Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <important> <para> Canceling a Spot instance request does not terminate running Spot instances associated with the request. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the CancelSpotInstanceRequests service method.</param> <returns>The response from the CancelSpotInstanceRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelSpotInstanceRequestsAsync(Amazon.EC2.Model.CancelSpotInstanceRequestsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelSpotInstanceRequests operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelSpotInstanceRequests operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ConfirmProductInstance(Amazon.EC2.Model.ConfirmProductInstanceRequest)"> <summary> Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmProductInstance service method.</param> <returns>The response from the ConfirmProductInstance service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ConfirmProductInstanceAsync(Amazon.EC2.Model.ConfirmProductInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ConfirmProductInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmProductInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CopyImage(Amazon.EC2.Model.CopyImageRequest)"> <summary> Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted EBS snapshots cannot be copied with this method. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html">Copying AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CopyImage service method.</param> <returns>The response from the CopyImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CopyImageAsync(Amazon.EC2.Model.CopyImageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopyImage operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyImage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CopySnapshot(Amazon.EC2.Model.CopySnapshotRequest)"> <summary> Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to. <para> Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the <code>Encrypted</code> flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the <code>KmsKeyId</code> parameter. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-copy-snapshot.html">Copying an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CopySnapshot service method.</param> <returns>The response from the CopySnapshot service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CopySnapshotAsync(Amazon.EC2.Model.CopySnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopySnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CopySnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateCustomerGateway(Amazon.EC2.Model.CreateCustomerGatewayRequest)"> <summary> Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT). <para> For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range). </para> <note> <para> Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the <code>us-east-1</code> region, and 9059, which is reserved in the <code>eu-west-1</code> region. </para> </note> <para> For more information about VPN customer gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <important> <para> You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the CreateCustomerGateway service method.</param> <returns>The response from the CreateCustomerGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateCustomerGatewayAsync(Amazon.EC2.Model.CreateCustomerGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCustomerGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCustomerGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateDhcpOptions(Amazon.EC2.Model.CreateDhcpOptionsRequest)"> <summary> Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>. <ul> <li> <code>domain-name-servers</code> - The IP addresses of up to four domain name servers, or <code>AmazonProvidedDNS</code>. The default DHCP option set specifies <code>AmazonProvidedDNS</code>. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.</li> <li> <code>domain-name</code> - If you're using AmazonProvidedDNS in <code>us-east-1</code>, specify <code>ec2.internal</code>. If you're using AmazonProvidedDNS in another region, specify <code>region.compute.internal</code> (for example, <code>ap-northeast-1.compute.internal</code>). Otherwise, specify a domain name (for example, <code>MyCompany.com</code>). <b>Important</b>: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.</li> <li> <code>ntp-servers</code> - The IP addresses of up to four Network Time Protocol (NTP) servers.</li> <li> <code>netbios-name-servers</code> - The IP addresses of up to four NetBIOS name servers.</li> <li> <code>netbios-node-type</code> - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>. </li> </ul> <para> Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the <code>domain-name-servers</code> option either to <code>AmazonProvidedDNS</code> or to a domain name server of your choice. For more information about DHCP options, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDhcpOptions service method.</param> <returns>The response from the CreateDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateDhcpOptionsAsync(Amazon.EC2.Model.CreateDhcpOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDhcpOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDhcpOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateFlowLogs(Amazon.EC2.Model.CreateFlowLogsRequest)"> <summary> Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs. <para> In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateFlowLogs service method.</param> <returns>The response from the CreateFlowLogs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateFlowLogsAsync(Amazon.EC2.Model.CreateFlowLogsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateFlowLogs operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateFlowLogs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateImage(Amazon.EC2.Model.CreateImageRequest)"> <summary> Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. <para> If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html">Creating Amazon EBS-Backed Linux AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateImage service method.</param> <returns>The response from the CreateImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateImageAsync(Amazon.EC2.Model.CreateImageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateImage operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateImage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateInstanceExportTask(Amazon.EC2.Model.CreateInstanceExportTaskRequest)"> <summary> Exports a running or stopped instance to an S3 bucket. <para> For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ExportingEC2Instances.html">Exporting EC2 Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateInstanceExportTask service method.</param> <returns>The response from the CreateInstanceExportTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateInstanceExportTaskAsync(Amazon.EC2.Model.CreateInstanceExportTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateInstanceExportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInstanceExportTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateInternetGateway"> <summary> Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using <a>AttachInternetGateway</a>. <para> For more information about your VPC and Internet gateway, see the <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/">Amazon Virtual Private Cloud User Guide</a>. </para> </summary> <returns>The response from the CreateInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateInternetGateway(Amazon.EC2.Model.CreateInternetGatewayRequest)"> <summary> Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using <a>AttachInternetGateway</a>. <para> For more information about your VPC and Internet gateway, see the <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/">Amazon Virtual Private Cloud User Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateInternetGateway service method.</param> <returns>The response from the CreateInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateInternetGatewayAsync(Amazon.EC2.Model.CreateInternetGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateInternetGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInternetGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateKeyPair(Amazon.EC2.Model.CreateKeyPairRequest)"> <summary> Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error. <para> You can have up to five thousand key pairs per region. </para> <para> The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use <a>ImportKeyPair</a>. </para> <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateKeyPair service method.</param> <returns>The response from the CreateKeyPair service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateKeyPairAsync(Amazon.EC2.Model.CreateKeyPairRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateKeyPair operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateKeyPair operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateNetworkAcl(Amazon.EC2.Model.CreateNetworkAclRequest)"> <summary> Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC. <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkAcl service method.</param> <returns>The response from the CreateNetworkAcl service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateNetworkAclAsync(Amazon.EC2.Model.CreateNetworkAclRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateNetworkAcl operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkAcl operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateNetworkAclEntry(Amazon.EC2.Model.CreateNetworkAclEntryRequest)"> <summary> Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules. <para> We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules. </para> <para> After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one. </para> <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkAclEntry service method.</param> <returns>The response from the CreateNetworkAclEntry service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateNetworkAclEntryAsync(Amazon.EC2.Model.CreateNetworkAclEntryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateNetworkAclEntry operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkAclEntry operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateNetworkInterface(Amazon.EC2.Model.CreateNetworkInterfaceRequest)"> <summary> Creates a network interface in the specified subnet. <para> For more information about network interfaces, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html">Elastic Network Interfaces</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkInterface service method.</param> <returns>The response from the CreateNetworkInterface service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateNetworkInterfaceAsync(Amazon.EC2.Model.CreateNetworkInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateNetworkInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreatePlacementGroup(Amazon.EC2.Model.CreatePlacementGroupRequest)"> <summary> Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account. <para> For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreatePlacementGroup service method.</param> <returns>The response from the CreatePlacementGroup service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreatePlacementGroupAsync(Amazon.EC2.Model.CreatePlacementGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePlacementGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePlacementGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateReservedInstancesListing(Amazon.EC2.Model.CreateReservedInstancesListingRequest)"> <summary> Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the <a>DescribeReservedInstances</a> operation. <para> The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. </para> <para> To sell your Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the <a>DescribeReservedInstancesListings</a> operation. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateReservedInstancesListing service method.</param> <returns>The response from the CreateReservedInstancesListing service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateReservedInstancesListingAsync(Amazon.EC2.Model.CreateReservedInstancesListingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateReservedInstancesListing operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateReservedInstancesListing operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateRoute(Amazon.EC2.Model.CreateRouteRequest)"> <summary> Creates a route in a route table within a VPC. <para> You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface. </para> <para> When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for <code>192.0.2.3</code>, and the route table includes the following two routes: </para> <ul> <li> <para> <code>192.0.2.0/24</code> (goes to some target A) </para> </li> <li> <para> <code>192.0.2.0/28</code> (goes to some target B) </para> </li> </ul> <para> Both routes apply to the traffic destined for <code>192.0.2.3</code>. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic. </para> <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateRoute service method.</param> <returns>The response from the CreateRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateRouteAsync(Amazon.EC2.Model.CreateRouteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateRoute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateRouteTable(Amazon.EC2.Model.CreateRouteTableRequest)"> <summary> Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateRouteTable service method.</param> <returns>The response from the CreateRouteTable service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateRouteTableAsync(Amazon.EC2.Model.CreateRouteTableRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateRouteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateRouteTable operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateSecurityGroup(Amazon.EC2.Model.CreateSecurityGroupRequest)"> <summary> Creates a security group. <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <important> <para> EC2-Classic: You can have up to 500 security groups. </para> <para> EC2-VPC: You can create up to 100 security groups per VPC. </para> </important> <para> When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name. </para> <para> You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other. </para> <para> You can add or remove rules from your security groups using <a>AuthorizeSecurityGroupIngress</a>, <a>AuthorizeSecurityGroupEgress</a>, <a>RevokeSecurityGroupIngress</a>, and <a>RevokeSecurityGroupEgress</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateSecurityGroup service method.</param> <returns>The response from the CreateSecurityGroup service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateSecurityGroupAsync(Amazon.EC2.Model.CreateSecurityGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSecurityGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateSnapshot(Amazon.EC2.Model.CreateSnapshotRequest)"> <summary> Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance. <para> When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot. </para> <para> You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is <code>pending</code>. </para> <para> To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot. </para> <para> Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html">Amazon Elastic Block Store</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot service method.</param> <returns>The response from the CreateSnapshot service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateSnapshotAsync(Amazon.EC2.Model.CreateSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateSpotDatafeedSubscription(Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest)"> <summary> Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the CreateSpotDatafeedSubscription service method.</param> <returns>The response from the CreateSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateSpotDatafeedSubscriptionAsync(Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSpotDatafeedSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSpotDatafeedSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateSubnet(Amazon.EC2.Model.CreateSubnetRequest)"> <summary> Creates a subnet in an existing VPC. <para> When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). </para> <important> <para> AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use. </para> </important> <para> If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle. </para> <para> If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available. </para> <para> For more information about subnets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateSubnet service method.</param> <returns>The response from the CreateSubnet service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateSubnetAsync(Amazon.EC2.Model.CreateSubnetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSubnet operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSubnet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateTags(Amazon.EC2.Model.CreateTagsRequest)"> <summary> Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateTags service method.</param> <returns>The response from the CreateTags service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateTagsAsync(Amazon.EC2.Model.CreateTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTags operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVolume(Amazon.EC2.Model.CreateVolumeRequest)"> <summary> Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. <para> You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume. </para> <para> You can create encrypted volumes with the <code>Encrypted</code> parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-volume.html">Creating or Restoring an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVolume service method.</param> <returns>The response from the CreateVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVolumeAsync(Amazon.EC2.Model.CreateVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpc(Amazon.EC2.Model.CreateVpcRequest)"> <summary> Creates a VPC with the specified CIDR block. <para> The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <para> By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpc service method.</param> <returns>The response from the CreateVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpcAsync(Amazon.EC2.Model.CreateVpcRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpc operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpcEndpoint(Amazon.EC2.Model.CreateVpcEndpointRequest)"> <summary> Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. <para> Currently, only endpoints to Amazon S3 are supported. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpcEndpoint service method.</param> <returns>The response from the CreateVpcEndpoint service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpcEndpointAsync(Amazon.EC2.Model.CreateVpcEndpointRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVpcEndpoint operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpcEndpoint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpcPeeringConnection(Amazon.EC2.Model.CreateVpcPeeringConnectionRequest)"> <summary> Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks. <para> The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected. </para> <para> A <code>CreateVpcPeeringConnection</code> request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of <code>failed</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpcPeeringConnection service method.</param> <returns>The response from the CreateVpcPeeringConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpcPeeringConnectionAsync(Amazon.EC2.Model.CreateVpcPeeringConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVpcPeeringConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpcPeeringConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpnConnection(Amazon.EC2.Model.CreateVpnConnectionRequest)"> <summary> Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is <code>ipsec.1</code>. <para> The response includes information that you need to give to your network administrator to configure your customer gateway. </para> <important> <para> We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. </para> </important> <para> If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call. </para> <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnConnection service method.</param> <returns>The response from the CreateVpnConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpnConnectionAsync(Amazon.EC2.Model.CreateVpnConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVpnConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpnConnectionRoute(Amazon.EC2.Model.CreateVpnConnectionRouteRequest)"> <summary> Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnConnectionRoute service method.</param> <returns>The response from the CreateVpnConnectionRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpnConnectionRouteAsync(Amazon.EC2.Model.CreateVpnConnectionRouteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVpnConnectionRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnConnectionRoute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpnGateway(Amazon.EC2.Model.CreateVpnGatewayRequest)"> <summary> Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself. <para> For more information about virtual private gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnGateway service method.</param> <returns>The response from the CreateVpnGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpnGatewayAsync(Amazon.EC2.Model.CreateVpnGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVpnGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteCustomerGateway(Amazon.EC2.Model.DeleteCustomerGatewayRequest)"> <summary> Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCustomerGateway service method.</param> <returns>The response from the DeleteCustomerGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteCustomerGatewayAsync(Amazon.EC2.Model.DeleteCustomerGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCustomerGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCustomerGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteDhcpOptions(Amazon.EC2.Model.DeleteDhcpOptionsRequest)"> <summary> Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDhcpOptions service method.</param> <returns>The response from the DeleteDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteDhcpOptionsAsync(Amazon.EC2.Model.DeleteDhcpOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDhcpOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDhcpOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteFlowLogs(Amazon.EC2.Model.DeleteFlowLogsRequest)"> <summary> Deletes one or more flow logs. </summary> <param name="request">Container for the necessary parameters to execute the DeleteFlowLogs service method.</param> <returns>The response from the DeleteFlowLogs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteFlowLogsAsync(Amazon.EC2.Model.DeleteFlowLogsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteFlowLogs operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteFlowLogs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteInternetGateway(Amazon.EC2.Model.DeleteInternetGatewayRequest)"> <summary> Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInternetGateway service method.</param> <returns>The response from the DeleteInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteInternetGatewayAsync(Amazon.EC2.Model.DeleteInternetGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteInternetGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInternetGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteKeyPair(Amazon.EC2.Model.DeleteKeyPairRequest)"> <summary> Deletes the specified key pair, by removing the public key from Amazon EC2. </summary> <param name="request">Container for the necessary parameters to execute the DeleteKeyPair service method.</param> <returns>The response from the DeleteKeyPair service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteKeyPairAsync(Amazon.EC2.Model.DeleteKeyPairRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteKeyPair operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteKeyPair operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteNetworkAcl(Amazon.EC2.Model.DeleteNetworkAclRequest)"> <summary> Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkAcl service method.</param> <returns>The response from the DeleteNetworkAcl service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteNetworkAclAsync(Amazon.EC2.Model.DeleteNetworkAclRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteNetworkAcl operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkAcl operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteNetworkAclEntry(Amazon.EC2.Model.DeleteNetworkAclEntryRequest)"> <summary> Deletes the specified ingress or egress entry (rule) from the specified network ACL. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkAclEntry service method.</param> <returns>The response from the DeleteNetworkAclEntry service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteNetworkAclEntryAsync(Amazon.EC2.Model.DeleteNetworkAclEntryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteNetworkAclEntry operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkAclEntry operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteNetworkInterface(Amazon.EC2.Model.DeleteNetworkInterfaceRequest)"> <summary> Deletes the specified network interface. You must detach the network interface before you can delete it. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkInterface service method.</param> <returns>The response from the DeleteNetworkInterface service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteNetworkInterfaceAsync(Amazon.EC2.Model.DeleteNetworkInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteNetworkInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeletePlacementGroup(Amazon.EC2.Model.DeletePlacementGroupRequest)"> <summary> Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeletePlacementGroup service method.</param> <returns>The response from the DeletePlacementGroup service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeletePlacementGroupAsync(Amazon.EC2.Model.DeletePlacementGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePlacementGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePlacementGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteRoute(Amazon.EC2.Model.DeleteRouteRequest)"> <summary> Deletes the specified route from the specified route table. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRoute service method.</param> <returns>The response from the DeleteRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteRouteAsync(Amazon.EC2.Model.DeleteRouteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRoute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteRouteTable(Amazon.EC2.Model.DeleteRouteTableRequest)"> <summary> Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRouteTable service method.</param> <returns>The response from the DeleteRouteTable service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteRouteTableAsync(Amazon.EC2.Model.DeleteRouteTableRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRouteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRouteTable operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteSecurityGroup(Amazon.EC2.Model.DeleteSecurityGroupRequest)"> <summary> Deletes a security group. <para> If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with <code>InvalidGroup.InUse</code> in EC2-Classic or <code>DependencyViolation</code> in EC2-VPC. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSecurityGroup service method.</param> <returns>The response from the DeleteSecurityGroup service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteSecurityGroupAsync(Amazon.EC2.Model.DeleteSecurityGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSecurityGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteSnapshot(Amazon.EC2.Model.DeleteSnapshotRequest)"> <summary> Deletes the specified snapshot. <para> When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume. </para> <para> You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-snapshot.html">Deleting an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot service method.</param> <returns>The response from the DeleteSnapshot service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteSnapshotAsync(Amazon.EC2.Model.DeleteSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteSpotDatafeedSubscription"> <summary> Deletes the data feed for Spot instances. </summary> <returns>The response from the DeleteSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteSpotDatafeedSubscription(Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionRequest)"> <summary> Deletes the data feed for Spot instances. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSpotDatafeedSubscription service method.</param> <returns>The response from the DeleteSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteSpotDatafeedSubscriptionAsync(Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSpotDatafeedSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSpotDatafeedSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteSubnet(Amazon.EC2.Model.DeleteSubnetRequest)"> <summary> Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSubnet service method.</param> <returns>The response from the DeleteSubnet service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteSubnetAsync(Amazon.EC2.Model.DeleteSubnetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSubnet operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSubnet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteTags(Amazon.EC2.Model.DeleteTagsRequest)"> <summary> Deletes the specified set of tags from the specified set of resources. This call is designed to follow a <code>DescribeTags</code> request. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags service method.</param> <returns>The response from the DeleteTags service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteTagsAsync(Amazon.EC2.Model.DeleteTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVolume(Amazon.EC2.Model.DeleteVolumeRequest)"> <summary> Deletes the specified EBS volume. The volume must be in the <code>available</code> state (not attached to an instance). <note> <para> The volume may remain in the <code>deleting</code> state for several minutes. </para> </note> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-volume.html">Deleting an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVolume service method.</param> <returns>The response from the DeleteVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVolumeAsync(Amazon.EC2.Model.DeleteVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpc(Amazon.EC2.Model.DeleteVpcRequest)"> <summary> Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpc service method.</param> <returns>The response from the DeleteVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpcAsync(Amazon.EC2.Model.DeleteVpcRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpc operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpcEndpoints(Amazon.EC2.Model.DeleteVpcEndpointsRequest)"> <summary> Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpcEndpoints service method.</param> <returns>The response from the DeleteVpcEndpoints service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpcEndpointsAsync(Amazon.EC2.Model.DeleteVpcEndpointsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVpcEndpoints operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpcEndpoints operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpcPeeringConnection(Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest)"> <summary> Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the <code>active</code> state. The owner of the requester VPC can delete a VPC peering connection in the <code>pending-acceptance</code> state. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpcPeeringConnection service method.</param> <returns>The response from the DeleteVpcPeeringConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpcPeeringConnectionAsync(Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVpcPeeringConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpcPeeringConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpnConnection(Amazon.EC2.Model.DeleteVpnConnectionRequest)"> <summary> Deletes the specified VPN connection. <para> If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnConnection service method.</param> <returns>The response from the DeleteVpnConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpnConnectionAsync(Amazon.EC2.Model.DeleteVpnConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVpnConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpnConnectionRoute(Amazon.EC2.Model.DeleteVpnConnectionRouteRequest)"> <summary> Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnConnectionRoute service method.</param> <returns>The response from the DeleteVpnConnectionRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpnConnectionRouteAsync(Amazon.EC2.Model.DeleteVpnConnectionRouteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVpnConnectionRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnConnectionRoute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpnGateway(Amazon.EC2.Model.DeleteVpnGatewayRequest)"> <summary> Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnGateway service method.</param> <returns>The response from the DeleteVpnGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpnGatewayAsync(Amazon.EC2.Model.DeleteVpnGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVpnGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeregisterImage(Amazon.EC2.Model.DeregisterImageRequest)"> <summary> Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances. <para> This command does not delete the AMI. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterImage service method.</param> <returns>The response from the DeregisterImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeregisterImageAsync(Amazon.EC2.Model.DeregisterImageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterImage operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterImage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeAccountAttributes"> <summary> Describes attributes of your AWS account. The following are the supported account attributes: <ul> <li> <para> <code>supported-platforms</code>: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC. </para> </li> <li> <para> <code>default-vpc</code>: The ID of the default VPC for your account, or <code>none</code>. </para> </li> <li> <para> <code>max-instances</code>: The maximum number of On-Demand instances that you can run. </para> </li> <li> <para> <code>vpc-max-security-groups-per-interface</code>: The maximum number of security groups that you can assign to a network interface. </para> </li> <li> <para> <code>max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic. </para> </li> <li> <para> <code>vpc-max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC. </para> </li> </ul> </summary> <returns>The response from the DescribeAccountAttributes service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeAccountAttributes(Amazon.EC2.Model.DescribeAccountAttributesRequest)"> <summary> Describes attributes of your AWS account. The following are the supported account attributes: <ul> <li> <para> <code>supported-platforms</code>: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC. </para> </li> <li> <para> <code>default-vpc</code>: The ID of the default VPC for your account, or <code>none</code>. </para> </li> <li> <para> <code>max-instances</code>: The maximum number of On-Demand instances that you can run. </para> </li> <li> <para> <code>vpc-max-security-groups-per-interface</code>: The maximum number of security groups that you can assign to a network interface. </para> </li> <li> <para> <code>max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic. </para> </li> <li> <para> <code>vpc-max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountAttributes service method.</param> <returns>The response from the DescribeAccountAttributes service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeAccountAttributesAsync(Amazon.EC2.Model.DescribeAccountAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAccountAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeAddresses"> <summary> Describes one or more of your Elastic IP addresses. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeAddresses(Amazon.EC2.Model.DescribeAddressesRequest)"> <summary> Describes one or more of your Elastic IP addresses. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAddresses service method.</param> <returns>The response from the DescribeAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeAddressesAsync(Amazon.EC2.Model.DescribeAddressesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAddresses operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeAvailabilityZones"> <summary> Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html">Regions and Availability Zones</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeAvailabilityZones service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeAvailabilityZones(Amazon.EC2.Model.DescribeAvailabilityZonesRequest)"> <summary> Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html">Regions and Availability Zones</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityZones service method.</param> <returns>The response from the DescribeAvailabilityZones service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeAvailabilityZonesAsync(Amazon.EC2.Model.DescribeAvailabilityZonesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAvailabilityZones operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityZones operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeBundleTasks"> <summary> Describes one or more of your bundling tasks. <note> <para> Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided to the bundle task. </para> </note> </summary> <returns>The response from the DescribeBundleTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeBundleTasks(Amazon.EC2.Model.DescribeBundleTasksRequest)"> <summary> Describes one or more of your bundling tasks. <note> <para> Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided to the bundle task. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeBundleTasks service method.</param> <returns>The response from the DescribeBundleTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeBundleTasksAsync(Amazon.EC2.Model.DescribeBundleTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeBundleTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeBundleTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeClassicLinkInstances(Amazon.EC2.Model.DescribeClassicLinkInstancesRequest)"> <summary> Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClassicLinkInstances service method.</param> <returns>The response from the DescribeClassicLinkInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeClassicLinkInstancesAsync(Amazon.EC2.Model.DescribeClassicLinkInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClassicLinkInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClassicLinkInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeConversionTasks"> <summary> Describes one or more of your conversion tasks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <returns>The response from the DescribeConversionTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeConversionTasks(Amazon.EC2.Model.DescribeConversionTasksRequest)"> <summary> Describes one or more of your conversion tasks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConversionTasks service method.</param> <returns>The response from the DescribeConversionTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeConversionTasksAsync(Amazon.EC2.Model.DescribeConversionTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConversionTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConversionTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeCustomerGateways"> <summary> Describes one or more of your VPN customer gateways. <para> For more information about VPN customer gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeCustomerGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeCustomerGateways(Amazon.EC2.Model.DescribeCustomerGatewaysRequest)"> <summary> Describes one or more of your VPN customer gateways. <para> For more information about VPN customer gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCustomerGateways service method.</param> <returns>The response from the DescribeCustomerGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeCustomerGatewaysAsync(Amazon.EC2.Model.DescribeCustomerGatewaysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCustomerGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCustomerGateways operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeDhcpOptions"> <summary> Describes one or more of your DHCP options sets. <para> For more information about DHCP options sets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeDhcpOptions(Amazon.EC2.Model.DescribeDhcpOptionsRequest)"> <summary> Describes one or more of your DHCP options sets. <para> For more information about DHCP options sets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDhcpOptions service method.</param> <returns>The response from the DescribeDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeDhcpOptionsAsync(Amazon.EC2.Model.DescribeDhcpOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDhcpOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDhcpOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeExportTasks"> <summary> Describes one or more of your export tasks. </summary> <returns>The response from the DescribeExportTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeExportTasks(Amazon.EC2.Model.DescribeExportTasksRequest)"> <summary> Describes one or more of your export tasks. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExportTasks service method.</param> <returns>The response from the DescribeExportTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeExportTasksAsync(Amazon.EC2.Model.DescribeExportTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeExportTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExportTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeFlowLogs(Amazon.EC2.Model.DescribeFlowLogsRequest)"> <summary> Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API. </summary> <param name="request">Container for the necessary parameters to execute the DescribeFlowLogs service method.</param> <returns>The response from the DescribeFlowLogs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeFlowLogsAsync(Amazon.EC2.Model.DescribeFlowLogsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeFlowLogs operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeFlowLogs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeImageAttribute(Amazon.EC2.Model.DescribeImageAttributeRequest)"> <summary> Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImageAttribute service method.</param> <returns>The response from the DescribeImageAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeImageAttributeAsync(Amazon.EC2.Model.DescribeImageAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeImageAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImageAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeImages"> <summary> Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions. <note> <para> Deregistered images are included in the returned results for an unspecified interval after deregistration. </para> </note> </summary> <returns>The response from the DescribeImages service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeImages(Amazon.EC2.Model.DescribeImagesRequest)"> <summary> Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions. <note> <para> Deregistered images are included in the returned results for an unspecified interval after deregistration. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeImages service method.</param> <returns>The response from the DescribeImages service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeImagesAsync(Amazon.EC2.Model.DescribeImagesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeImages operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImages operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeImportImageTasks(Amazon.EC2.Model.DescribeImportImageTasksRequest)"> <summary> Displays details about an import virtual machine or import snapshot tasks that are already created. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImportImageTasks service method.</param> <returns>The response from the DescribeImportImageTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeImportImageTasksAsync(Amazon.EC2.Model.DescribeImportImageTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeImportImageTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImportImageTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeImportSnapshotTasks(Amazon.EC2.Model.DescribeImportSnapshotTasksRequest)"> <summary> Describes your import snapshot tasks. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImportSnapshotTasks service method.</param> <returns>The response from the DescribeImportSnapshotTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeImportSnapshotTasksAsync(Amazon.EC2.Model.DescribeImportSnapshotTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeImportSnapshotTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImportSnapshotTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInstanceAttribute(Amazon.EC2.Model.DescribeInstanceAttributeRequest)"> <summary> Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: <code>instanceType</code> | <code>kernel</code> | <code>ramdisk</code> | <code>userData</code> | <code>disableApiTermination</code> | <code>instanceInitiatedShutdownBehavior</code> | <code>rootDeviceName</code> | <code>blockDeviceMapping</code> | <code>productCodes</code> | <code>sourceDestCheck</code> | <code>groupSet</code> | <code>ebsOptimized</code> | <code>sriovNetSupport</code> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceAttribute service method.</param> <returns>The response from the DescribeInstanceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInstanceAttributeAsync(Amazon.EC2.Model.DescribeInstanceAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInstanceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInstances"> <summary> Describes one or more of your instances. <para> If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results. </para> <para> Recently terminated instances might appear in the returned results. This interval is usually less than one hour. </para> </summary> <returns>The response from the DescribeInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInstances(Amazon.EC2.Model.DescribeInstancesRequest)"> <summary> Describes one or more of your instances. <para> If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results. </para> <para> Recently terminated instances might appear in the returned results. This interval is usually less than one hour. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstances service method.</param> <returns>The response from the DescribeInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInstancesAsync(Amazon.EC2.Model.DescribeInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInstanceStatus"> <summary> Describes the status of one or more instances. <para> Instance status includes the following components: </para> <ul> <li> <para> <b>Status checks</b> - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html">Status Checks for Your Instances</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html">Troubleshooting Instances with Failed Status Checks</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Scheduled events</b> - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html">Scheduled Events for Your Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Instance state</b> - You can manage your instances from the moment you launch them through their termination. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> </ul> </summary> <returns>The response from the DescribeInstanceStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInstanceStatus(Amazon.EC2.Model.DescribeInstanceStatusRequest)"> <summary> Describes the status of one or more instances. <para> Instance status includes the following components: </para> <ul> <li> <para> <b>Status checks</b> - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html">Status Checks for Your Instances</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html">Troubleshooting Instances with Failed Status Checks</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Scheduled events</b> - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html">Scheduled Events for Your Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Instance state</b> - You can manage your instances from the moment you launch them through their termination. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceStatus service method.</param> <returns>The response from the DescribeInstanceStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInstanceStatusAsync(Amazon.EC2.Model.DescribeInstanceStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInstanceStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInternetGateways"> <summary> Describes one or more of your Internet gateways. </summary> <returns>The response from the DescribeInternetGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInternetGateways(Amazon.EC2.Model.DescribeInternetGatewaysRequest)"> <summary> Describes one or more of your Internet gateways. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInternetGateways service method.</param> <returns>The response from the DescribeInternetGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInternetGatewaysAsync(Amazon.EC2.Model.DescribeInternetGatewaysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInternetGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInternetGateways operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeKeyPairs"> <summary> Describes one or more of your key pairs. <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeKeyPairs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeKeyPairs(Amazon.EC2.Model.DescribeKeyPairsRequest)"> <summary> Describes one or more of your key pairs. <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeKeyPairs service method.</param> <returns>The response from the DescribeKeyPairs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeKeyPairsAsync(Amazon.EC2.Model.DescribeKeyPairsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeKeyPairs operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeKeyPairs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeMovingAddresses(Amazon.EC2.Model.DescribeMovingAddressesRequest)"> <summary> Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMovingAddresses service method.</param> <returns>The response from the DescribeMovingAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeMovingAddressesAsync(Amazon.EC2.Model.DescribeMovingAddressesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeMovingAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMovingAddresses operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeNetworkAcls"> <summary> Describes one or more of your network ACLs. <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeNetworkAcls service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeNetworkAcls(Amazon.EC2.Model.DescribeNetworkAclsRequest)"> <summary> Describes one or more of your network ACLs. <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkAcls service method.</param> <returns>The response from the DescribeNetworkAcls service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeNetworkAclsAsync(Amazon.EC2.Model.DescribeNetworkAclsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeNetworkAcls operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkAcls operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeNetworkInterfaceAttribute(Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest)"> <summary> Describes a network interface attribute. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkInterfaceAttribute service method.</param> <returns>The response from the DescribeNetworkInterfaceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeNetworkInterfaceAttributeAsync(Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeNetworkInterfaceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkInterfaceAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeNetworkInterfaces"> <summary> Describes one or more of your network interfaces. </summary> <returns>The response from the DescribeNetworkInterfaces service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeNetworkInterfaces(Amazon.EC2.Model.DescribeNetworkInterfacesRequest)"> <summary> Describes one or more of your network interfaces. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkInterfaces service method.</param> <returns>The response from the DescribeNetworkInterfaces service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeNetworkInterfacesAsync(Amazon.EC2.Model.DescribeNetworkInterfacesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeNetworkInterfaces operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkInterfaces operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribePlacementGroups"> <summary> Describes one or more of your placement groups. For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <returns>The response from the DescribePlacementGroups service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribePlacementGroups(Amazon.EC2.Model.DescribePlacementGroupsRequest)"> <summary> Describes one or more of your placement groups. For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribePlacementGroups service method.</param> <returns>The response from the DescribePlacementGroups service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribePlacementGroupsAsync(Amazon.EC2.Model.DescribePlacementGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribePlacementGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePlacementGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribePrefixLists(Amazon.EC2.Model.DescribePrefixListsRequest)"> <summary> Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a VPC endpoint. </summary> <param name="request">Container for the necessary parameters to execute the DescribePrefixLists service method.</param> <returns>The response from the DescribePrefixLists service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribePrefixListsAsync(Amazon.EC2.Model.DescribePrefixListsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribePrefixLists operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePrefixLists operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeRegions"> <summary> Describes one or more regions that are currently available to you. <para> For a list of the regions supported by Amazon EC2, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region">Regions and Endpoints</a>. </para> </summary> <returns>The response from the DescribeRegions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeRegions(Amazon.EC2.Model.DescribeRegionsRequest)"> <summary> Describes one or more regions that are currently available to you. <para> For a list of the regions supported by Amazon EC2, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region">Regions and Endpoints</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeRegions service method.</param> <returns>The response from the DescribeRegions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeRegionsAsync(Amazon.EC2.Model.DescribeRegionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeRegions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRegions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstances"> <summary> Describes one or more of the Reserved Instances that you purchased. <para> For more information about Reserved Instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeReservedInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstances(Amazon.EC2.Model.DescribeReservedInstancesRequest)"> <summary> Describes one or more of the Reserved Instances that you purchased. <para> For more information about Reserved Instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstances service method.</param> <returns>The response from the DescribeReservedInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstancesAsync(Amazon.EC2.Model.DescribeReservedInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstancesListings"> <summary> Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. <para> The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. </para> <para> As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase. </para> <para> As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeReservedInstancesListings service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstancesListings(Amazon.EC2.Model.DescribeReservedInstancesListingsRequest)"> <summary> Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. <para> The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. </para> <para> As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase. </para> <para> As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesListings service method.</param> <returns>The response from the DescribeReservedInstancesListings service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstancesListingsAsync(Amazon.EC2.Model.DescribeReservedInstancesListingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedInstancesListings operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesListings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstancesModifications"> <summary> Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> <returns>The response from the DescribeReservedInstancesModifications service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstancesModifications(Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest)"> <summary> Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesModifications service method.</param> <returns>The response from the DescribeReservedInstancesModifications service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstancesModificationsAsync(Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedInstancesModifications operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesModifications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstancesOfferings"> <summary> Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeReservedInstancesOfferings service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstancesOfferings(Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest)"> <summary> Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesOfferings service method.</param> <returns>The response from the DescribeReservedInstancesOfferings service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstancesOfferingsAsync(Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedInstancesOfferings operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesOfferings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeRouteTables"> <summary> Describes one or more of your route tables. <para> Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations. </para> <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeRouteTables service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeRouteTables(Amazon.EC2.Model.DescribeRouteTablesRequest)"> <summary> Describes one or more of your route tables. <para> Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations. </para> <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeRouteTables service method.</param> <returns>The response from the DescribeRouteTables service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeRouteTablesAsync(Amazon.EC2.Model.DescribeRouteTablesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeRouteTables operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRouteTables operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSecurityGroups"> <summary> Describes one or more of your security groups. <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeSecurityGroups service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSecurityGroups(Amazon.EC2.Model.DescribeSecurityGroupsRequest)"> <summary> Describes one or more of your security groups. <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSecurityGroups service method.</param> <returns>The response from the DescribeSecurityGroups service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSecurityGroupsAsync(Amazon.EC2.Model.DescribeSecurityGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSecurityGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSecurityGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSnapshotAttribute(Amazon.EC2.Model.DescribeSnapshotAttributeRequest)"> <summary> Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time. <para> For more information about EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshotAttribute service method.</param> <returns>The response from the DescribeSnapshotAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSnapshotAttributeAsync(Amazon.EC2.Model.DescribeSnapshotAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSnapshotAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshotAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSnapshots"> <summary> Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions. <para> The create volume permissions fall into the following categories: </para> <ul> <li> <i>public</i>: The owner of the snapshot granted create volume permissions for the snapshot to the <code>all</code> group. All AWS accounts have create volume permissions for these snapshots.</li> <li> <i>explicit</i>: The owner of the snapshot granted create volume permissions to a specific AWS account.</li> <li> <i>implicit</i>: An AWS account has implicit create volume permissions for all snapshots it owns.</li> </ul> <para> The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. </para> <para> If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results. </para> <para> If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, <code>amazon</code> for snapshots owned by Amazon, or <code>self</code> for snapshots that you own. </para> <para> If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), <code>self</code> for snapshots for which you own or have explicit permissions, or <code>all</code> for public snapshots. </para> <para> If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSnapshots</code> request to retrieve the remaining results. </para> <para> For more information about EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeSnapshots service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSnapshots(Amazon.EC2.Model.DescribeSnapshotsRequest)"> <summary> Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions. <para> The create volume permissions fall into the following categories: </para> <ul> <li> <i>public</i>: The owner of the snapshot granted create volume permissions for the snapshot to the <code>all</code> group. All AWS accounts have create volume permissions for these snapshots.</li> <li> <i>explicit</i>: The owner of the snapshot granted create volume permissions to a specific AWS account.</li> <li> <i>implicit</i>: An AWS account has implicit create volume permissions for all snapshots it owns.</li> </ul> <para> The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. </para> <para> If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results. </para> <para> If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, <code>amazon</code> for snapshots owned by Amazon, or <code>self</code> for snapshots that you own. </para> <para> If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), <code>self</code> for snapshots for which you own or have explicit permissions, or <code>all</code> for public snapshots. </para> <para> If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSnapshots</code> request to retrieve the remaining results. </para> <para> For more information about EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots service method.</param> <returns>The response from the DescribeSnapshots service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSnapshotsAsync(Amazon.EC2.Model.DescribeSnapshotsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSnapshots operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotDatafeedSubscription"> <summary> Describes the data feed for Spot instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <returns>The response from the DescribeSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotDatafeedSubscription(Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionRequest)"> <summary> Describes the data feed for Spot instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotDatafeedSubscription service method.</param> <returns>The response from the DescribeSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotDatafeedSubscriptionAsync(Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSpotDatafeedSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotDatafeedSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotFleetInstances(Amazon.EC2.Model.DescribeSpotFleetInstancesRequest)"> <summary> Describes the running instances for the specified Spot fleet. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetInstances service method.</param> <returns>The response from the DescribeSpotFleetInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotFleetInstancesAsync(Amazon.EC2.Model.DescribeSpotFleetInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSpotFleetInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotFleetRequestHistory(Amazon.EC2.Model.DescribeSpotFleetRequestHistoryRequest)"> <summary> Describes the events for the specified Spot fleet request during the specified time. <para> Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetRequestHistory service method.</param> <returns>The response from the DescribeSpotFleetRequestHistory service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotFleetRequestHistoryAsync(Amazon.EC2.Model.DescribeSpotFleetRequestHistoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSpotFleetRequestHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetRequestHistory operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotFleetRequests(Amazon.EC2.Model.DescribeSpotFleetRequestsRequest)"> <summary> Describes your Spot fleet requests. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetRequests service method.</param> <returns>The response from the DescribeSpotFleetRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotFleetRequestsAsync(Amazon.EC2.Model.DescribeSpotFleetRequestsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSpotFleetRequests operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetRequests operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotInstanceRequests"> <summary> Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> You can use <code>DescribeSpotInstanceRequests</code> to find a running Spot instance by examining the response. If the status of the Spot instance is <code>fulfilled</code>, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use <a>DescribeInstances</a> with a filter to look for instances where the instance lifecycle is <code>spot</code>. </para> </summary> <returns>The response from the DescribeSpotInstanceRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotInstanceRequests(Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest)"> <summary> Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> You can use <code>DescribeSpotInstanceRequests</code> to find a running Spot instance by examining the response. If the status of the Spot instance is <code>fulfilled</code>, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use <a>DescribeInstances</a> with a filter to look for instances where the instance lifecycle is <code>spot</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotInstanceRequests service method.</param> <returns>The response from the DescribeSpotInstanceRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotInstanceRequestsAsync(Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSpotInstanceRequests operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotInstanceRequests operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotPriceHistory"> <summary> Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html">Spot Instance Pricing History</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed. </para> </summary> <returns>The response from the DescribeSpotPriceHistory service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotPriceHistory(Amazon.EC2.Model.DescribeSpotPriceHistoryRequest)"> <summary> Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html">Spot Instance Pricing History</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotPriceHistory service method.</param> <returns>The response from the DescribeSpotPriceHistory service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotPriceHistoryAsync(Amazon.EC2.Model.DescribeSpotPriceHistoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSpotPriceHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotPriceHistory operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSubnets"> <summary> Describes one or more of your subnets. <para> For more information about subnets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeSubnets service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSubnets(Amazon.EC2.Model.DescribeSubnetsRequest)"> <summary> Describes one or more of your subnets. <para> For more information about subnets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSubnets service method.</param> <returns>The response from the DescribeSubnets service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSubnetsAsync(Amazon.EC2.Model.DescribeSubnetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSubnets operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSubnets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeTags"> <summary> Describes one or more of the tags for your EC2 resources. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeTags service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeTags(Amazon.EC2.Model.DescribeTagsRequest)"> <summary> Describes one or more of the tags for your EC2 resources. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags service method.</param> <returns>The response from the DescribeTags service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeTagsAsync(Amazon.EC2.Model.DescribeTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVolumeAttribute(Amazon.EC2.Model.DescribeVolumeAttributeRequest)"> <summary> Describes the specified attribute of the specified volume. You can specify only one attribute at a time. <para> For more information about EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumeAttribute service method.</param> <returns>The response from the DescribeVolumeAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVolumeAttributeAsync(Amazon.EC2.Model.DescribeVolumeAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVolumeAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumeAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVolumes"> <summary> Describes the specified EBS volumes. <para> If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeVolumes</code> request to retrieve the remaining results. </para> <para> For more information about EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeVolumes service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVolumes(Amazon.EC2.Model.DescribeVolumesRequest)"> <summary> Describes the specified EBS volumes. <para> If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeVolumes</code> request to retrieve the remaining results. </para> <para> For more information about EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumes service method.</param> <returns>The response from the DescribeVolumes service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVolumesAsync(Amazon.EC2.Model.DescribeVolumesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVolumes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVolumeStatus"> <summary> Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event. <para> The <code>DescribeVolumeStatus</code> operation provides the following information about the specified volumes: </para> <para> <i>Status</i>: Reflects the current status of the volume. The possible values are <code>ok</code>, <code>impaired</code> , <code>warning</code>, or <code>insufficient-data</code>. If all checks pass, the overall status of the volume is <code>ok</code>. If the check fails, the overall status is <code>impaired</code>. If the status is <code>insufficient-data</code>, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html">Monitoring the Status of Your Volumes</a>. </para> <para> <i>Events</i>: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an <code>impaired</code> status, then the volume event might be <code>potential-data-inconsistency</code>. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data. </para> <para> <i>Actions</i>: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is <code>impaired</code> and the volume event shows <code>potential-data-inconsistency</code>, then the action shows <code>enable-volume-io</code>. This means that you may want to enable the I/O operations for the volume by calling the <a>EnableVolumeIO</a> action and then check the volume for data consistency. </para> <note> <para> Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the <code>error</code> state (for example, when a volume is incapable of accepting I/O.) </para> </note> </summary> <returns>The response from the DescribeVolumeStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVolumeStatus(Amazon.EC2.Model.DescribeVolumeStatusRequest)"> <summary> Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event. <para> The <code>DescribeVolumeStatus</code> operation provides the following information about the specified volumes: </para> <para> <i>Status</i>: Reflects the current status of the volume. The possible values are <code>ok</code>, <code>impaired</code> , <code>warning</code>, or <code>insufficient-data</code>. If all checks pass, the overall status of the volume is <code>ok</code>. If the check fails, the overall status is <code>impaired</code>. If the status is <code>insufficient-data</code>, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html">Monitoring the Status of Your Volumes</a>. </para> <para> <i>Events</i>: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an <code>impaired</code> status, then the volume event might be <code>potential-data-inconsistency</code>. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data. </para> <para> <i>Actions</i>: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is <code>impaired</code> and the volume event shows <code>potential-data-inconsistency</code>, then the action shows <code>enable-volume-io</code>. This means that you may want to enable the I/O operations for the volume by calling the <a>EnableVolumeIO</a> action and then check the volume for data consistency. </para> <note> <para> Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the <code>error</code> state (for example, when a volume is incapable of accepting I/O.) </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumeStatus service method.</param> <returns>The response from the DescribeVolumeStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVolumeStatusAsync(Amazon.EC2.Model.DescribeVolumeStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVolumeStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumeStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcAttribute(Amazon.EC2.Model.DescribeVpcAttributeRequest)"> <summary> Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcAttribute service method.</param> <returns>The response from the DescribeVpcAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcAttributeAsync(Amazon.EC2.Model.DescribeVpcAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVpcAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcClassicLink(Amazon.EC2.Model.DescribeVpcClassicLinkRequest)"> <summary> Describes the ClassicLink status of one or more VPCs. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcClassicLink service method.</param> <returns>The response from the DescribeVpcClassicLink service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcClassicLinkAsync(Amazon.EC2.Model.DescribeVpcClassicLinkRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVpcClassicLink operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcClassicLink operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcEndpoints(Amazon.EC2.Model.DescribeVpcEndpointsRequest)"> <summary> Describes one or more of your VPC endpoints. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcEndpoints service method.</param> <returns>The response from the DescribeVpcEndpoints service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcEndpointsAsync(Amazon.EC2.Model.DescribeVpcEndpointsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVpcEndpoints operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcEndpoints operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcEndpointServices(Amazon.EC2.Model.DescribeVpcEndpointServicesRequest)"> <summary> Describes all supported AWS services that can be specified when creating a VPC endpoint. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcEndpointServices service method.</param> <returns>The response from the DescribeVpcEndpointServices service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcEndpointServicesAsync(Amazon.EC2.Model.DescribeVpcEndpointServicesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVpcEndpointServices operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcEndpointServices operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcPeeringConnections"> <summary> Describes one or more of your VPC peering connections. </summary> <returns>The response from the DescribeVpcPeeringConnections service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcPeeringConnections(Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest)"> <summary> Describes one or more of your VPC peering connections. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcPeeringConnections service method.</param> <returns>The response from the DescribeVpcPeeringConnections service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcPeeringConnectionsAsync(Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVpcPeeringConnections operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcPeeringConnections operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcs"> <summary> Describes one or more of your VPCs. </summary> <returns>The response from the DescribeVpcs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcs(Amazon.EC2.Model.DescribeVpcsRequest)"> <summary> Describes one or more of your VPCs. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcs service method.</param> <returns>The response from the DescribeVpcs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcsAsync(Amazon.EC2.Model.DescribeVpcsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVpcs operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpnConnections"> <summary> Describes one or more of your VPN connections. <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeVpnConnections service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpnConnections(Amazon.EC2.Model.DescribeVpnConnectionsRequest)"> <summary> Describes one or more of your VPN connections. <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpnConnections service method.</param> <returns>The response from the DescribeVpnConnections service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpnConnectionsAsync(Amazon.EC2.Model.DescribeVpnConnectionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVpnConnections operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpnConnections operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpnGateways"> <summary> Describes one or more of your virtual private gateways. <para> For more information about virtual private gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding an IPsec Hardware VPN to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeVpnGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpnGateways(Amazon.EC2.Model.DescribeVpnGatewaysRequest)"> <summary> Describes one or more of your virtual private gateways. <para> For more information about virtual private gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding an IPsec Hardware VPN to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpnGateways service method.</param> <returns>The response from the DescribeVpnGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpnGatewaysAsync(Amazon.EC2.Model.DescribeVpnGatewaysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVpnGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpnGateways operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DetachClassicLinkVpc(Amazon.EC2.Model.DetachClassicLinkVpcRequest)"> <summary> Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped. </summary> <param name="request">Container for the necessary parameters to execute the DetachClassicLinkVpc service method.</param> <returns>The response from the DetachClassicLinkVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DetachClassicLinkVpcAsync(Amazon.EC2.Model.DetachClassicLinkVpcRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachClassicLinkVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachClassicLinkVpc operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DetachInternetGateway(Amazon.EC2.Model.DetachInternetGatewayRequest)"> <summary> Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses. </summary> <param name="request">Container for the necessary parameters to execute the DetachInternetGateway service method.</param> <returns>The response from the DetachInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DetachInternetGatewayAsync(Amazon.EC2.Model.DetachInternetGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachInternetGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachInternetGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DetachNetworkInterface(Amazon.EC2.Model.DetachNetworkInterfaceRequest)"> <summary> Detaches a network interface from an instance. </summary> <param name="request">Container for the necessary parameters to execute the DetachNetworkInterface service method.</param> <returns>The response from the DetachNetworkInterface service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DetachNetworkInterfaceAsync(Amazon.EC2.Model.DetachNetworkInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachNetworkInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachNetworkInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DetachVolume(Amazon.EC2.Model.DetachVolumeRequest)"> <summary> Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching. <para> If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first. </para> <para> When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-detaching-volume.html">Detaching an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachVolume service method.</param> <returns>The response from the DetachVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DetachVolumeAsync(Amazon.EC2.Model.DetachVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DetachVpnGateway(Amazon.EC2.Model.DetachVpnGatewayRequest)"> <summary> Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described). <para> You must wait for the attachment's state to switch to <code>detached</code> before you can delete the VPC or attach a different VPC to the virtual private gateway. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachVpnGateway service method.</param> <returns>The response from the DetachVpnGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DetachVpnGatewayAsync(Amazon.EC2.Model.DetachVpnGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachVpnGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachVpnGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DisableVgwRoutePropagation(Amazon.EC2.Model.DisableVgwRoutePropagationRequest)"> <summary> Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC. </summary> <param name="request">Container for the necessary parameters to execute the DisableVgwRoutePropagation service method.</param> <returns>The response from the DisableVgwRoutePropagation service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DisableVgwRoutePropagationAsync(Amazon.EC2.Model.DisableVgwRoutePropagationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableVgwRoutePropagation operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableVgwRoutePropagation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DisableVpcClassicLink(Amazon.EC2.Model.DisableVpcClassicLinkRequest)"> <summary> Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it. </summary> <param name="request">Container for the necessary parameters to execute the DisableVpcClassicLink service method.</param> <returns>The response from the DisableVpcClassicLink service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DisableVpcClassicLinkAsync(Amazon.EC2.Model.DisableVpcClassicLinkRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableVpcClassicLink operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableVpcClassicLink operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DisassociateAddress(Amazon.EC2.Model.DisassociateAddressRequest)"> <summary> Disassociates an Elastic IP address from the instance or network interface it's associated with. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. </para> </summary> <param name="request">Container for the necessary parameters to execute the DisassociateAddress service method.</param> <returns>The response from the DisassociateAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DisassociateAddressAsync(Amazon.EC2.Model.DisassociateAddressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisassociateAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the DisassociateAddress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DisassociateRouteTable(Amazon.EC2.Model.DisassociateRouteTableRequest)"> <summary> Disassociates a subnet from a route table. <para> After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DisassociateRouteTable service method.</param> <returns>The response from the DisassociateRouteTable service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DisassociateRouteTableAsync(Amazon.EC2.Model.DisassociateRouteTableRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisassociateRouteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the DisassociateRouteTable operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EnableVgwRoutePropagation(Amazon.EC2.Model.EnableVgwRoutePropagationRequest)"> <summary> Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC. </summary> <param name="request">Container for the necessary parameters to execute the EnableVgwRoutePropagation service method.</param> <returns>The response from the EnableVgwRoutePropagation service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EnableVgwRoutePropagationAsync(Amazon.EC2.Model.EnableVgwRoutePropagationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableVgwRoutePropagation operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableVgwRoutePropagation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EnableVolumeIO(Amazon.EC2.Model.EnableVolumeIORequest)"> <summary> Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent. </summary> <param name="request">Container for the necessary parameters to execute the EnableVolumeIO service method.</param> <returns>The response from the EnableVolumeIO service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EnableVolumeIOAsync(Amazon.EC2.Model.EnableVolumeIORequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableVolumeIO operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableVolumeIO operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EnableVpcClassicLink(Amazon.EC2.Model.EnableVpcClassicLinkRequest)"> <summary> Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the <code>10.0.0.0/8</code> IP address range, excluding local routes for VPCs in the <code>10.0.0.0/16</code> and <code>10.1.0.0/16</code> IP address ranges. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the Amazon Elastic Compute Cloud User Guide. </summary> <param name="request">Container for the necessary parameters to execute the EnableVpcClassicLink service method.</param> <returns>The response from the EnableVpcClassicLink service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EnableVpcClassicLinkAsync(Amazon.EC2.Model.EnableVpcClassicLinkRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableVpcClassicLink operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableVpcClassicLink operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.GetConsoleOutput(Amazon.EC2.Model.GetConsoleOutputRequest)"> <summary> Gets the console output for the specified instance. <para> Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface. </para> <para> Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post. </para> <para> For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it. </para> <para> For Windows instances, the instance console output includes output from the EC2Config service. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetConsoleOutput service method.</param> <returns>The response from the GetConsoleOutput service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.GetConsoleOutputAsync(Amazon.EC2.Model.GetConsoleOutputRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetConsoleOutput operation. </summary> <param name="request">Container for the necessary parameters to execute the GetConsoleOutput operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.GetPasswordData(Amazon.EC2.Model.GetPasswordDataRequest)"> <summary> Retrieves the encrypted administrator password for an instance running Windows. <para> The Windows password is generated at boot if the <code>EC2Config</code> service plugin, <code>Ec2SetPassword</code>, is enabled. This usually only happens the first time an AMI is launched, and then <code>Ec2SetPassword</code> is automatically disabled. The password is not generated for rebundled AMIs unless <code>Ec2SetPassword</code> is enabled before bundling. </para> <para> The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file. </para> <para> Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetPasswordData service method.</param> <returns>The response from the GetPasswordData service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.GetPasswordDataAsync(Amazon.EC2.Model.GetPasswordDataRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetPasswordData operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPasswordData operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ImportImage(Amazon.EC2.Model.ImportImageRequest)"> <summary> Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). </summary> <param name="request">Container for the necessary parameters to execute the ImportImage service method.</param> <returns>The response from the ImportImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ImportImageAsync(Amazon.EC2.Model.ImportImageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ImportImage operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportImage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ImportInstance(Amazon.EC2.Model.ImportInstanceRequest)"> <summary> Creates an import instance task using metadata from the specified disk image. <code>ImportInstance</code> only supports single-volume VMs. To import multi-volume VMs, use <a>ImportImage</a>. After importing the image, you then upload it using the <code>ec2-import-volume</code> command in the EC2 command line tools. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ImportInstance service method.</param> <returns>The response from the ImportInstance service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ImportInstanceAsync(Amazon.EC2.Model.ImportInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ImportInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ImportKeyPair(Amazon.EC2.Model.ImportKeyPairRequest)"> <summary> Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with <a>CreateKeyPair</a>, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS. <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ImportKeyPair service method.</param> <returns>The response from the ImportKeyPair service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ImportKeyPairAsync(Amazon.EC2.Model.ImportKeyPairRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ImportKeyPair operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportKeyPair operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ImportSnapshot(Amazon.EC2.Model.ImportSnapshotRequest)"> <summary> Imports a disk into an EBS snapshot. </summary> <param name="request">Container for the necessary parameters to execute the ImportSnapshot service method.</param> <returns>The response from the ImportSnapshot service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ImportSnapshotAsync(Amazon.EC2.Model.ImportSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ImportSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ImportVolume(Amazon.EC2.Model.ImportVolumeRequest)"> <summary> Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the <code>ec2-import-volume</code> command in the Amazon EC2 command-line interface (CLI) tools. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ImportVolume service method.</param> <returns>The response from the ImportVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ImportVolumeAsync(Amazon.EC2.Model.ImportVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ImportVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyImageAttribute(Amazon.EC2.Model.ModifyImageAttributeRequest)"> <summary> Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. <note> <para> AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ModifyImageAttribute service method.</param> <returns>The response from the ModifyImageAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyImageAttributeAsync(Amazon.EC2.Model.ModifyImageAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyImageAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyImageAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyInstanceAttribute(Amazon.EC2.Model.ModifyInstanceAttributeRequest)"> <summary> Modifies the specified attribute of the specified instance. You can specify only one attribute at a time. <para> To modify some attributes, the instance must be stopped. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingAttributesWhileInstanceStopped.html">Modifying Attributes of a Stopped Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyInstanceAttribute service method.</param> <returns>The response from the ModifyInstanceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyInstanceAttributeAsync(Amazon.EC2.Model.ModifyInstanceAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyInstanceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyInstanceAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyNetworkInterfaceAttribute(Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest)"> <summary> Modifies the specified network interface attribute. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the ModifyNetworkInterfaceAttribute service method.</param> <returns>The response from the ModifyNetworkInterfaceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyNetworkInterfaceAttributeAsync(Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyNetworkInterfaceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyNetworkInterfaceAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyReservedInstances(Amazon.EC2.Model.ModifyReservedInstancesRequest)"> <summary> Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyReservedInstances service method.</param> <returns>The response from the ModifyReservedInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyReservedInstancesAsync(Amazon.EC2.Model.ModifyReservedInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyReservedInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyReservedInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifySnapshotAttribute(Amazon.EC2.Model.ModifySnapshotAttributeRequest)"> <summary> Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls. <para> For more information on modifying snapshot permissions, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html">Sharing Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <note> <para> Snapshots with AWS Marketplace product codes cannot be made public. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ModifySnapshotAttribute service method.</param> <returns>The response from the ModifySnapshotAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifySnapshotAttributeAsync(Amazon.EC2.Model.ModifySnapshotAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifySnapshotAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifySnapshotAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifySubnetAttribute(Amazon.EC2.Model.ModifySubnetAttributeRequest)"> <summary> Modifies a subnet attribute. </summary> <param name="request">Container for the necessary parameters to execute the ModifySubnetAttribute service method.</param> <returns>The response from the ModifySubnetAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifySubnetAttributeAsync(Amazon.EC2.Model.ModifySubnetAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifySubnetAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifySubnetAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyVolumeAttribute(Amazon.EC2.Model.ModifyVolumeAttributeRequest)"> <summary> Modifies a volume attribute. <para> By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume. </para> <para> You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyVolumeAttribute service method.</param> <returns>The response from the ModifyVolumeAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyVolumeAttributeAsync(Amazon.EC2.Model.ModifyVolumeAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyVolumeAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVolumeAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyVpcAttribute(Amazon.EC2.Model.ModifyVpcAttributeRequest)"> <summary> Modifies the specified attribute of the specified VPC. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVpcAttribute service method.</param> <returns>The response from the ModifyVpcAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyVpcAttributeAsync(Amazon.EC2.Model.ModifyVpcAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyVpcAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVpcAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyVpcEndpoint(Amazon.EC2.Model.ModifyVpcEndpointRequest)"> <summary> Modifies attributes of a specified VPC endpoint. You can modify the policy associated with the endpoint, and you can add and remove route tables associated with the endpoint. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVpcEndpoint service method.</param> <returns>The response from the ModifyVpcEndpoint service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyVpcEndpointAsync(Amazon.EC2.Model.ModifyVpcEndpointRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyVpcEndpoint operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVpcEndpoint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.MonitorInstances(Amazon.EC2.Model.MonitorInstancesRequest)"> <summary> Enables monitoring for a running instance. For more information about monitoring instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitoring Your Instances and Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the MonitorInstances service method.</param> <returns>The response from the MonitorInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.MonitorInstancesAsync(Amazon.EC2.Model.MonitorInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the MonitorInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the MonitorInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.MoveAddressToVpc(Amazon.EC2.Model.MoveAddressToVpcRequest)"> <summary> Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the <a>RestoreAddressToClassic</a> request. You cannot move an Elastic IP address that's allocated for use in the EC2-VPC platform to the EC2-Classic platform. </summary> <param name="request">Container for the necessary parameters to execute the MoveAddressToVpc service method.</param> <returns>The response from the MoveAddressToVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.MoveAddressToVpcAsync(Amazon.EC2.Model.MoveAddressToVpcRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the MoveAddressToVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the MoveAddressToVpc operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.PurchaseReservedInstancesOffering(Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest)"> <summary> Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time and pay a lower hourly rate compared to on-Demand Instance pricing. <para> Use <a>DescribeReservedInstancesOfferings</a> to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with <a>DescribeReservedInstances</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedInstancesOffering service method.</param> <returns>The response from the PurchaseReservedInstancesOffering service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.PurchaseReservedInstancesOfferingAsync(Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PurchaseReservedInstancesOffering operation. </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedInstancesOffering operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RebootInstances(Amazon.EC2.Model.RebootInstancesRequest)"> <summary> Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. <para> If a Linux/Unix instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html">Getting Console Output and Rebooting Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RebootInstances service method.</param> <returns>The response from the RebootInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RebootInstancesAsync(Amazon.EC2.Model.RebootInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RebootInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the RebootInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RegisterImage(Amazon.EC2.Model.RegisterImageRequest)"> <summary> Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html">Creating Your Own AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <note> <para> For Amazon EBS-backed instances, <a>CreateImage</a> creates and registers the AMI in a single request, so you don't have to register the AMI yourself. </para> </note> <para> You can also use <code>RegisterImage</code> to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_LaunchingInstanceFromSnapshot.html">Launching an Instance from a Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <important> <para> Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 <code>billingProduct</code> code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure. </para> <para> Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI. </para> <para> To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see <a>CreateImage</a>. </para> </important> <para> If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image. </para> <note> <para> You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the RegisterImage service method.</param> <returns>The response from the RegisterImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RegisterImageAsync(Amazon.EC2.Model.RegisterImageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterImage operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterImage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RejectVpcPeeringConnection(Amazon.EC2.Model.RejectVpcPeeringConnectionRequest)"> <summary> Rejects a VPC peering connection request. The VPC peering connection must be in the <code>pending-acceptance</code> state. Use the <a>DescribeVpcPeeringConnections</a> request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use <a>DeleteVpcPeeringConnection</a>. </summary> <param name="request">Container for the necessary parameters to execute the RejectVpcPeeringConnection service method.</param> <returns>The response from the RejectVpcPeeringConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RejectVpcPeeringConnectionAsync(Amazon.EC2.Model.RejectVpcPeeringConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RejectVpcPeeringConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the RejectVpcPeeringConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReleaseAddress(Amazon.EC2.Model.ReleaseAddressRequest)"> <summary> Releases the specified Elastic IP address. <para> After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an <code>AuthFailure</code> error if the address is already allocated to another AWS account. </para> <para> [EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use <a>DisassociateAddress</a>. </para> <para> [Nondefault VPC] You must use <a>DisassociateAddress</a> to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (<code>InvalidIPAddress.InUse</code>). </para> </summary> <param name="request">Container for the necessary parameters to execute the ReleaseAddress service method.</param> <returns>The response from the ReleaseAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReleaseAddressAsync(Amazon.EC2.Model.ReleaseAddressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReleaseAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the ReleaseAddress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReplaceNetworkAclAssociation(Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest)"> <summary> Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceNetworkAclAssociation service method.</param> <returns>The response from the ReplaceNetworkAclAssociation service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReplaceNetworkAclAssociationAsync(Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReplaceNetworkAclAssociation operation. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceNetworkAclAssociation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReplaceNetworkAclEntry(Amazon.EC2.Model.ReplaceNetworkAclEntryRequest)"> <summary> Replaces an entry (rule) in a network ACL. For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceNetworkAclEntry service method.</param> <returns>The response from the ReplaceNetworkAclEntry service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReplaceNetworkAclEntryAsync(Amazon.EC2.Model.ReplaceNetworkAclEntryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReplaceNetworkAclEntry operation. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceNetworkAclEntry operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReplaceRoute(Amazon.EC2.Model.ReplaceRouteRequest)"> <summary> Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReplaceRoute service method.</param> <returns>The response from the ReplaceRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReplaceRouteAsync(Amazon.EC2.Model.ReplaceRouteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReplaceRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceRoute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReplaceRouteTableAssociation(Amazon.EC2.Model.ReplaceRouteTableAssociationRequest)"> <summary> Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. <para> You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReplaceRouteTableAssociation service method.</param> <returns>The response from the ReplaceRouteTableAssociation service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReplaceRouteTableAssociationAsync(Amazon.EC2.Model.ReplaceRouteTableAssociationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReplaceRouteTableAssociation operation. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceRouteTableAssociation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReportInstanceStatus(Amazon.EC2.Model.ReportInstanceStatusRequest)"> <summary> Submits feedback about the status of an instance. The instance must be in the <code>running</code> state. If your experience with the instance differs from the instance status returned by <a>DescribeInstanceStatus</a>, use <a>ReportInstanceStatus</a> to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. <para> Use of this action does not change the value returned by <a>DescribeInstanceStatus</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReportInstanceStatus service method.</param> <returns>The response from the ReportInstanceStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReportInstanceStatusAsync(Amazon.EC2.Model.ReportInstanceStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReportInstanceStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the ReportInstanceStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RequestSpotFleet(Amazon.EC2.Model.RequestSpotFleetRequest)"> <summary> Creates a Spot fleet request. <para> You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet. </para> <para> By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload. </para> <para> Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html">Spot Fleet Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RequestSpotFleet service method.</param> <returns>The response from the RequestSpotFleet service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RequestSpotFleetAsync(Amazon.EC2.Model.RequestSpotFleetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RequestSpotFleet operation. </summary> <param name="request">Container for the necessary parameters to execute the RequestSpotFleet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RequestSpotInstances(Amazon.EC2.Model.RequestSpotInstancesRequest)"> <summary> Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the RequestSpotInstances service method.</param> <returns>The response from the RequestSpotInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RequestSpotInstancesAsync(Amazon.EC2.Model.RequestSpotInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RequestSpotInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the RequestSpotInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ResetImageAttribute(Amazon.EC2.Model.ResetImageAttributeRequest)"> <summary> Resets an attribute of an AMI to its default value. <note> <para> The productCodes attribute can't be reset. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ResetImageAttribute service method.</param> <returns>The response from the ResetImageAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ResetImageAttributeAsync(Amazon.EC2.Model.ResetImageAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetImageAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetImageAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ResetInstanceAttribute(Amazon.EC2.Model.ResetInstanceAttributeRequest)"> <summary> Resets an attribute of an instance to its default value. To reset the <code>kernel</code> or <code>ramdisk</code>, the instance must be in a stopped state. To reset the <code>SourceDestCheck</code>, the instance can be either running or stopped. <para> The <code>SourceDestCheck</code> attribute controls whether source/destination checking is enabled. The default value is <code>true</code>, which means checking is enabled. This value must be <code>false</code> for a NAT instance to perform NAT. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html">NAT Instances</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ResetInstanceAttribute service method.</param> <returns>The response from the ResetInstanceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ResetInstanceAttributeAsync(Amazon.EC2.Model.ResetInstanceAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetInstanceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetInstanceAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ResetNetworkInterfaceAttribute(Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest)"> <summary> Resets a network interface attribute. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the ResetNetworkInterfaceAttribute service method.</param> <returns>The response from the ResetNetworkInterfaceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ResetNetworkInterfaceAttributeAsync(Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetNetworkInterfaceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetNetworkInterfaceAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ResetSnapshotAttribute(Amazon.EC2.Model.ResetSnapshotAttributeRequest)"> <summary> Resets permission settings for the specified snapshot. <para> For more information on modifying snapshot permissions, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html">Sharing Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ResetSnapshotAttribute service method.</param> <returns>The response from the ResetSnapshotAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ResetSnapshotAttributeAsync(Amazon.EC2.Model.ResetSnapshotAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetSnapshotAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetSnapshotAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RestoreAddressToClassic(Amazon.EC2.Model.RestoreAddressToClassicRequest)"> <summary> Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface. </summary> <param name="request">Container for the necessary parameters to execute the RestoreAddressToClassic service method.</param> <returns>The response from the RestoreAddressToClassic service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RestoreAddressToClassicAsync(Amazon.EC2.Model.RestoreAddressToClassicRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestoreAddressToClassic operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreAddressToClassic operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RevokeSecurityGroupEgress(Amazon.EC2.Model.RevokeSecurityGroupEgressRequest)"> <summary> Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked. <para> Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. </para> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> </summary> <param name="request">Container for the necessary parameters to execute the RevokeSecurityGroupEgress service method.</param> <returns>The response from the RevokeSecurityGroupEgress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RevokeSecurityGroupEgressAsync(Amazon.EC2.Model.RevokeSecurityGroupEgressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RevokeSecurityGroupEgress operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeSecurityGroupEgress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RevokeSecurityGroupIngress(Amazon.EC2.Model.RevokeSecurityGroupIngressRequest)"> <summary> Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed. <para> Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. </para> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> </summary> <param name="request">Container for the necessary parameters to execute the RevokeSecurityGroupIngress service method.</param> <returns>The response from the RevokeSecurityGroupIngress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RevokeSecurityGroupIngressAsync(Amazon.EC2.Model.RevokeSecurityGroupIngressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RevokeSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeSecurityGroupIngress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RunInstances(Amazon.EC2.Model.RunInstancesRequest)"> <summary> Launches the specified number of instances using an AMI for which you have permissions. <para> When you launch an instance, it enters the <code>pending</code> state. After the instance is ready for you, it enters the <code>running</code> state. To check the state of your instance, call <a>DescribeInstances</a>. </para> <para> If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> [EC2-VPC only accounts] If you don't specify a subnet in the request, we choose a default subnet from your default VPC for you. </para> <para> [EC2-Classic accounts] If you're launching into EC2-Classic and you don't specify an Availability Zone, we choose one for you. </para> <para> Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> You can provide optional user data when launching an instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html">Instance Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> If any of the AMIs have a product code attached for which the user has not subscribed, <code>RunInstances</code> fails. </para> <para> T2 instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, <code>RunInstances</code> fails. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_InstanceStraightToTerminated.html">What To Do If An Instance Immediately Terminates</a>, and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.html">Troubleshooting Connecting to Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RunInstances service method.</param> <returns>The response from the RunInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RunInstancesAsync(Amazon.EC2.Model.RunInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RunInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the RunInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.StartInstances(Amazon.EC2.Model.StartInstancesRequest)"> <summary> Starts an Amazon EBS-backed AMI that you've previously stopped. <para> Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour. </para> <para> Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. </para> <para> Performing this operation on an instance that uses an instance store as its root device returns an error. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html">Stopping Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StartInstances service method.</param> <returns>The response from the StartInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.StartInstancesAsync(Amazon.EC2.Model.StartInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the StartInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.StopInstances(Amazon.EC2.Model.StopInstancesRequest)"> <summary> Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour. <para> You can't start or stop Spot Instances. </para> <para> Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. </para> <para> Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. </para> <para> Performing this operation on an instance that uses an instance store as its root device returns an error. </para> <para> You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesStopping.html">Troubleshooting Stopping Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StopInstances service method.</param> <returns>The response from the StopInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.StopInstancesAsync(Amazon.EC2.Model.StopInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StopInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the StopInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.TerminateInstances(Amazon.EC2.Model.TerminateInstancesRequest)"> <summary> Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. <para> Terminated instances remain visible after termination (for approximately one hour). </para> <para> By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running. </para> <para> You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the <code>DeleteOnTermination</code> block device mapping parameter set to <code>true</code> are automatically deleted. For more information about the differences between stopping and terminating instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesShuttingDown.html">Troubleshooting Terminating Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the TerminateInstances service method.</param> <returns>The response from the TerminateInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.TerminateInstancesAsync(Amazon.EC2.Model.TerminateInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TerminateInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the TerminateInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.UnassignPrivateIpAddresses(Amazon.EC2.Model.UnassignPrivateIpAddressesRequest)"> <summary> Unassigns one or more secondary private IP addresses from a network interface. </summary> <param name="request">Container for the necessary parameters to execute the UnassignPrivateIpAddresses service method.</param> <returns>The response from the UnassignPrivateIpAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.UnassignPrivateIpAddressesAsync(Amazon.EC2.Model.UnassignPrivateIpAddressesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UnassignPrivateIpAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the UnassignPrivateIpAddresses operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.UnmonitorInstances(Amazon.EC2.Model.UnmonitorInstancesRequest)"> <summary> Disables monitoring for a running instance. For more information about monitoring instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitoring Your Instances and Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the UnmonitorInstances service method.</param> <returns>The response from the UnmonitorInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.UnmonitorInstancesAsync(Amazon.EC2.Model.UnmonitorInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UnmonitorInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the UnmonitorInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor"> <summary> Constructs AmazonEC2Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonEC2Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(Amazon.EC2.AmazonEC2Config)"> <summary> Constructs AmazonEC2Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonEC2Client Configuration Object</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonEC2Client with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonEC2Client with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(Amazon.Runtime.AWSCredentials,Amazon.EC2.AmazonEC2Config)"> <summary> Constructs AmazonEC2Client with AWS Credentials and an AmazonEC2Client Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonEC2Client Configuration Object</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(System.String,System.String)"> <summary> Constructs AmazonEC2Client with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonEC2Client with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(System.String,System.String,Amazon.EC2.AmazonEC2Config)"> <summary> Constructs AmazonEC2Client with AWS Access Key ID, AWS Secret Key and an AmazonEC2Client Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonEC2Client Configuration Object</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonEC2Client with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonEC2Client with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(System.String,System.String,System.String,Amazon.EC2.AmazonEC2Config)"> <summary> Constructs AmazonEC2Client with AWS Access Key ID, AWS Secret Key and an AmazonEC2Client Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonEC2Client Configuration Object</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AcceptVpcPeeringConnection(Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest)"> <summary> Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the <code>pending-acceptance</code> state, and you must be the owner of the peer VPC. Use the <code>DescribeVpcPeeringConnections</code> request to view your outstanding VPC peering connection requests. </summary> <param name="request">Container for the necessary parameters to execute the AcceptVpcPeeringConnection service method.</param> <returns>The response from the AcceptVpcPeeringConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AcceptVpcPeeringConnectionAsync(Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AcceptVpcPeeringConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the AcceptVpcPeeringConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AllocateAddress"> <summary> Acquires an Elastic IP address. <para> An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the AllocateAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AllocateAddress(Amazon.EC2.Model.AllocateAddressRequest)"> <summary> Acquires an Elastic IP address. <para> An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AllocateAddress service method.</param> <returns>The response from the AllocateAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AllocateAddressAsync(Amazon.EC2.Model.AllocateAddressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AllocateAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the AllocateAddress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AssignPrivateIpAddresses(Amazon.EC2.Model.AssignPrivateIpAddressesRequest)"> <summary> Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about Elastic IP addresses, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> AssignPrivateIpAddresses is available only in EC2-VPC. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssignPrivateIpAddresses service method.</param> <returns>The response from the AssignPrivateIpAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AssignPrivateIpAddressesAsync(Amazon.EC2.Model.AssignPrivateIpAddressesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssignPrivateIpAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the AssignPrivateIpAddresses operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AssociateAddress(Amazon.EC2.Model.AssociateAddressRequest)"> <summary> Associates an Elastic IP address with an instance or a network interface. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> [EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. </para> <para> [VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. </para> <para> This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssociateAddress service method.</param> <returns>The response from the AssociateAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AssociateAddressAsync(Amazon.EC2.Model.AssociateAddressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssociateAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the AssociateAddress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AssociateDhcpOptions(Amazon.EC2.Model.AssociateDhcpOptionsRequest)"> <summary> Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC. <para> After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssociateDhcpOptions service method.</param> <returns>The response from the AssociateDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AssociateDhcpOptionsAsync(Amazon.EC2.Model.AssociateDhcpOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssociateDhcpOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the AssociateDhcpOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AssociateRouteTable(Amazon.EC2.Model.AssociateRouteTableRequest)"> <summary> Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssociateRouteTable service method.</param> <returns>The response from the AssociateRouteTable service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AssociateRouteTableAsync(Amazon.EC2.Model.AssociateRouteTableRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssociateRouteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the AssociateRouteTable operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachClassicLinkVpc(Amazon.EC2.Model.AttachClassicLinkVpcRequest)"> <summary> Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the <code>running</code> state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it. <para> After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again. </para> <para> Linking your instance to a VPC is sometimes referred to as <i>attaching</i> your instance. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachClassicLinkVpc service method.</param> <returns>The response from the AttachClassicLinkVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachClassicLinkVpcAsync(Amazon.EC2.Model.AttachClassicLinkVpcRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachClassicLinkVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachClassicLinkVpc operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachInternetGateway(Amazon.EC2.Model.AttachInternetGatewayRequest)"> <summary> Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/">Amazon Virtual Private Cloud User Guide</a>. </summary> <param name="request">Container for the necessary parameters to execute the AttachInternetGateway service method.</param> <returns>The response from the AttachInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachInternetGatewayAsync(Amazon.EC2.Model.AttachInternetGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachInternetGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachInternetGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachNetworkInterface(Amazon.EC2.Model.AttachNetworkInterfaceRequest)"> <summary> Attaches a network interface to an instance. </summary> <param name="request">Container for the necessary parameters to execute the AttachNetworkInterface service method.</param> <returns>The response from the AttachNetworkInterface service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachNetworkInterfaceAsync(Amazon.EC2.Model.AttachNetworkInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachNetworkInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachNetworkInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachVolume(Amazon.EC2.Model.AttachVolumeRequest)"> <summary> Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. <para> Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For a list of supported device names, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html">Attaching an EBS Volume to an Instance</a>. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html">Amazon EC2 Instance Store</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> If a volume has an AWS Marketplace product code: </para> <ul> <li>The volume can be attached only to a stopped instance.</li> <li>AWS Marketplace product codes are copied from the volume to the instance.</li> <li>You must be subscribed to the product.</li> <li>The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.</li> </ul> <para> For an overview of the AWS Marketplace, see <a href="https://aws.amazon.com/marketplace/help/200900000">Introducing AWS Marketplace</a>. </para> <para> For more information about EBS volumes, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html">Attaching Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachVolume service method.</param> <returns>The response from the AttachVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachVolumeAsync(Amazon.EC2.Model.AttachVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachVpnGateway(Amazon.EC2.Model.AttachVpnGatewayRequest)"> <summary> Attaches a virtual private gateway to a VPC. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the AttachVpnGateway service method.</param> <returns>The response from the AttachVpnGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachVpnGatewayAsync(Amazon.EC2.Model.AttachVpnGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachVpnGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachVpnGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AuthorizeSecurityGroupEgress(Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest)"> <summary> Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC. <important> <para> You can have up to 50 rules per security group (covering both ingress and egress rules). </para> </important> <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <para> Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes. </para> <para> Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur. </para> </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSecurityGroupEgress service method.</param> <returns>The response from the AuthorizeSecurityGroupEgress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AuthorizeSecurityGroupEgressAsync(Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AuthorizeSecurityGroupEgress operation. </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSecurityGroupEgress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AuthorizeSecurityGroupIngress(Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest)"> <summary> Adds one or more ingress rules to a security group. <important> <para> EC2-Classic: You can have up to 100 rules per group. </para> <para> EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules). </para> </important> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> <para> [EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the <i>source groups</i>) permission to access a security group for your account. A source group can be for your own AWS account, or another. </para> <para> [EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the <i>source groups</i>) permission to access a security group for your VPC. The security groups must all be for the same VPC. </para> </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSecurityGroupIngress service method.</param> <returns>The response from the AuthorizeSecurityGroupIngress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AuthorizeSecurityGroupIngressAsync(Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AuthorizeSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSecurityGroupIngress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BundleInstance(Amazon.EC2.Model.BundleInstanceRequest)"> <summary> Bundles an Amazon instance store-backed Windows instance. <para> During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved. </para> <note> <para> This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS. </para> </note> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/Creating_InstanceStoreBacked_WinAMI.html">Creating an Instance Store-Backed Windows AMI</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the BundleInstance service method.</param> <returns>The response from the BundleInstance service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BundleInstanceAsync(Amazon.EC2.Model.BundleInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BundleInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the BundleInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelBundleTask(Amazon.EC2.Model.CancelBundleTaskRequest)"> <summary> Cancels a bundling operation for an instance store-backed Windows instance. </summary> <param name="request">Container for the necessary parameters to execute the CancelBundleTask service method.</param> <returns>The response from the CancelBundleTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelBundleTaskAsync(Amazon.EC2.Model.CancelBundleTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelBundleTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelBundleTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelConversionTask(Amazon.EC2.Model.CancelConversionTaskRequest)"> <summary> Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CancelConversionTask service method.</param> <returns>The response from the CancelConversionTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelConversionTaskAsync(Amazon.EC2.Model.CancelConversionTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelConversionTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelConversionTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelExportTask(Amazon.EC2.Model.CancelExportTaskRequest)"> <summary> Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error. </summary> <param name="request">Container for the necessary parameters to execute the CancelExportTask service method.</param> <returns>The response from the CancelExportTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelExportTaskAsync(Amazon.EC2.Model.CancelExportTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelExportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelExportTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelImportTask(Amazon.EC2.Model.CancelImportTaskRequest)"> <summary> Cancels an in-process import virtual machine or import snapshot task. </summary> <param name="request">Container for the necessary parameters to execute the CancelImportTask service method.</param> <returns>The response from the CancelImportTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelImportTaskAsync(Amazon.EC2.Model.CancelImportTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelImportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelImportTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelReservedInstancesListing(Amazon.EC2.Model.CancelReservedInstancesListingRequest)"> <summary> Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CancelReservedInstancesListing service method.</param> <returns>The response from the CancelReservedInstancesListing service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelReservedInstancesListingAsync(Amazon.EC2.Model.CancelReservedInstancesListingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelReservedInstancesListing operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelReservedInstancesListing operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelSpotFleetRequests(Amazon.EC2.Model.CancelSpotFleetRequestsRequest)"> <summary> Cancels the specified Spot fleet requests. </summary> <param name="request">Container for the necessary parameters to execute the CancelSpotFleetRequests service method.</param> <returns>The response from the CancelSpotFleetRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelSpotFleetRequestsAsync(Amazon.EC2.Model.CancelSpotFleetRequestsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelSpotFleetRequests operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelSpotFleetRequests operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelSpotInstanceRequests(Amazon.EC2.Model.CancelSpotInstanceRequestsRequest)"> <summary> Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <important> <para> Canceling a Spot instance request does not terminate running Spot instances associated with the request. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the CancelSpotInstanceRequests service method.</param> <returns>The response from the CancelSpotInstanceRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelSpotInstanceRequestsAsync(Amazon.EC2.Model.CancelSpotInstanceRequestsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelSpotInstanceRequests operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelSpotInstanceRequests operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConfirmProductInstance(Amazon.EC2.Model.ConfirmProductInstanceRequest)"> <summary> Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmProductInstance service method.</param> <returns>The response from the ConfirmProductInstance service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConfirmProductInstanceAsync(Amazon.EC2.Model.ConfirmProductInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ConfirmProductInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmProductInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CopyImage(Amazon.EC2.Model.CopyImageRequest)"> <summary> Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted EBS snapshots cannot be copied with this method. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html">Copying AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CopyImage service method.</param> <returns>The response from the CopyImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CopyImageAsync(Amazon.EC2.Model.CopyImageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopyImage operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyImage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CopySnapshot(Amazon.EC2.Model.CopySnapshotRequest)"> <summary> Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to. <para> Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the <code>Encrypted</code> flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the <code>KmsKeyId</code> parameter. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-copy-snapshot.html">Copying an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CopySnapshot service method.</param> <returns>The response from the CopySnapshot service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CopySnapshotAsync(Amazon.EC2.Model.CopySnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopySnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CopySnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateCustomerGateway(Amazon.EC2.Model.CreateCustomerGatewayRequest)"> <summary> Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT). <para> For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range). </para> <note> <para> Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the <code>us-east-1</code> region, and 9059, which is reserved in the <code>eu-west-1</code> region. </para> </note> <para> For more information about VPN customer gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <important> <para> You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the CreateCustomerGateway service method.</param> <returns>The response from the CreateCustomerGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateCustomerGatewayAsync(Amazon.EC2.Model.CreateCustomerGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCustomerGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCustomerGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateDhcpOptions(Amazon.EC2.Model.CreateDhcpOptionsRequest)"> <summary> Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>. <ul> <li> <code>domain-name-servers</code> - The IP addresses of up to four domain name servers, or <code>AmazonProvidedDNS</code>. The default DHCP option set specifies <code>AmazonProvidedDNS</code>. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.</li> <li> <code>domain-name</code> - If you're using AmazonProvidedDNS in <code>us-east-1</code>, specify <code>ec2.internal</code>. If you're using AmazonProvidedDNS in another region, specify <code>region.compute.internal</code> (for example, <code>ap-northeast-1.compute.internal</code>). Otherwise, specify a domain name (for example, <code>MyCompany.com</code>). <b>Important</b>: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.</li> <li> <code>ntp-servers</code> - The IP addresses of up to four Network Time Protocol (NTP) servers.</li> <li> <code>netbios-name-servers</code> - The IP addresses of up to four NetBIOS name servers.</li> <li> <code>netbios-node-type</code> - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>. </li> </ul> <para> Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the <code>domain-name-servers</code> option either to <code>AmazonProvidedDNS</code> or to a domain name server of your choice. For more information about DHCP options, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDhcpOptions service method.</param> <returns>The response from the CreateDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateDhcpOptionsAsync(Amazon.EC2.Model.CreateDhcpOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDhcpOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDhcpOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateFlowLogs(Amazon.EC2.Model.CreateFlowLogsRequest)"> <summary> Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs. <para> In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateFlowLogs service method.</param> <returns>The response from the CreateFlowLogs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateFlowLogsAsync(Amazon.EC2.Model.CreateFlowLogsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateFlowLogs operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateFlowLogs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateImage(Amazon.EC2.Model.CreateImageRequest)"> <summary> Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. <para> If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html">Creating Amazon EBS-Backed Linux AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateImage service method.</param> <returns>The response from the CreateImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateImageAsync(Amazon.EC2.Model.CreateImageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateImage operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateImage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateInstanceExportTask(Amazon.EC2.Model.CreateInstanceExportTaskRequest)"> <summary> Exports a running or stopped instance to an S3 bucket. <para> For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ExportingEC2Instances.html">Exporting EC2 Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateInstanceExportTask service method.</param> <returns>The response from the CreateInstanceExportTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateInstanceExportTaskAsync(Amazon.EC2.Model.CreateInstanceExportTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateInstanceExportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInstanceExportTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateInternetGateway"> <summary> Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using <a>AttachInternetGateway</a>. <para> For more information about your VPC and Internet gateway, see the <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/">Amazon Virtual Private Cloud User Guide</a>. </para> </summary> <returns>The response from the CreateInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateInternetGateway(Amazon.EC2.Model.CreateInternetGatewayRequest)"> <summary> Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using <a>AttachInternetGateway</a>. <para> For more information about your VPC and Internet gateway, see the <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/">Amazon Virtual Private Cloud User Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateInternetGateway service method.</param> <returns>The response from the CreateInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateInternetGatewayAsync(Amazon.EC2.Model.CreateInternetGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateInternetGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInternetGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateKeyPair(Amazon.EC2.Model.CreateKeyPairRequest)"> <summary> Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error. <para> You can have up to five thousand key pairs per region. </para> <para> The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use <a>ImportKeyPair</a>. </para> <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateKeyPair service method.</param> <returns>The response from the CreateKeyPair service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateKeyPairAsync(Amazon.EC2.Model.CreateKeyPairRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateKeyPair operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateKeyPair operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateNetworkAcl(Amazon.EC2.Model.CreateNetworkAclRequest)"> <summary> Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC. <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkAcl service method.</param> <returns>The response from the CreateNetworkAcl service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateNetworkAclAsync(Amazon.EC2.Model.CreateNetworkAclRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateNetworkAcl operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkAcl operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateNetworkAclEntry(Amazon.EC2.Model.CreateNetworkAclEntryRequest)"> <summary> Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules. <para> We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules. </para> <para> After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one. </para> <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkAclEntry service method.</param> <returns>The response from the CreateNetworkAclEntry service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateNetworkAclEntryAsync(Amazon.EC2.Model.CreateNetworkAclEntryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateNetworkAclEntry operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkAclEntry operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateNetworkInterface(Amazon.EC2.Model.CreateNetworkInterfaceRequest)"> <summary> Creates a network interface in the specified subnet. <para> For more information about network interfaces, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html">Elastic Network Interfaces</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkInterface service method.</param> <returns>The response from the CreateNetworkInterface service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateNetworkInterfaceAsync(Amazon.EC2.Model.CreateNetworkInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateNetworkInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreatePlacementGroup(Amazon.EC2.Model.CreatePlacementGroupRequest)"> <summary> Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account. <para> For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreatePlacementGroup service method.</param> <returns>The response from the CreatePlacementGroup service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreatePlacementGroupAsync(Amazon.EC2.Model.CreatePlacementGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePlacementGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePlacementGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateReservedInstancesListing(Amazon.EC2.Model.CreateReservedInstancesListingRequest)"> <summary> Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the <a>DescribeReservedInstances</a> operation. <para> The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. </para> <para> To sell your Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the <a>DescribeReservedInstancesListings</a> operation. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateReservedInstancesListing service method.</param> <returns>The response from the CreateReservedInstancesListing service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateReservedInstancesListingAsync(Amazon.EC2.Model.CreateReservedInstancesListingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateReservedInstancesListing operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateReservedInstancesListing operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateRoute(Amazon.EC2.Model.CreateRouteRequest)"> <summary> Creates a route in a route table within a VPC. <para> You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface. </para> <para> When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for <code>192.0.2.3</code>, and the route table includes the following two routes: </para> <ul> <li> <para> <code>192.0.2.0/24</code> (goes to some target A) </para> </li> <li> <para> <code>192.0.2.0/28</code> (goes to some target B) </para> </li> </ul> <para> Both routes apply to the traffic destined for <code>192.0.2.3</code>. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic. </para> <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateRoute service method.</param> <returns>The response from the CreateRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateRouteAsync(Amazon.EC2.Model.CreateRouteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateRoute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateRouteTable(Amazon.EC2.Model.CreateRouteTableRequest)"> <summary> Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateRouteTable service method.</param> <returns>The response from the CreateRouteTable service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateRouteTableAsync(Amazon.EC2.Model.CreateRouteTableRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateRouteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateRouteTable operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateSecurityGroup(Amazon.EC2.Model.CreateSecurityGroupRequest)"> <summary> Creates a security group. <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <important> <para> EC2-Classic: You can have up to 500 security groups. </para> <para> EC2-VPC: You can create up to 100 security groups per VPC. </para> </important> <para> When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name. </para> <para> You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other. </para> <para> You can add or remove rules from your security groups using <a>AuthorizeSecurityGroupIngress</a>, <a>AuthorizeSecurityGroupEgress</a>, <a>RevokeSecurityGroupIngress</a>, and <a>RevokeSecurityGroupEgress</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateSecurityGroup service method.</param> <returns>The response from the CreateSecurityGroup service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateSecurityGroupAsync(Amazon.EC2.Model.CreateSecurityGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSecurityGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateSnapshot(Amazon.EC2.Model.CreateSnapshotRequest)"> <summary> Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance. <para> When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot. </para> <para> You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is <code>pending</code>. </para> <para> To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot. </para> <para> Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html">Amazon Elastic Block Store</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot service method.</param> <returns>The response from the CreateSnapshot service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateSnapshotAsync(Amazon.EC2.Model.CreateSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateSpotDatafeedSubscription(Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest)"> <summary> Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the CreateSpotDatafeedSubscription service method.</param> <returns>The response from the CreateSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateSpotDatafeedSubscriptionAsync(Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSpotDatafeedSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSpotDatafeedSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateSubnet(Amazon.EC2.Model.CreateSubnetRequest)"> <summary> Creates a subnet in an existing VPC. <para> When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). </para> <important> <para> AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use. </para> </important> <para> If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle. </para> <para> If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available. </para> <para> For more information about subnets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateSubnet service method.</param> <returns>The response from the CreateSubnet service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateSubnetAsync(Amazon.EC2.Model.CreateSubnetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSubnet operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSubnet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateTags(Amazon.EC2.Model.CreateTagsRequest)"> <summary> Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateTags service method.</param> <returns>The response from the CreateTags service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateTagsAsync(Amazon.EC2.Model.CreateTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTags operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVolume(Amazon.EC2.Model.CreateVolumeRequest)"> <summary> Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. <para> You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume. </para> <para> You can create encrypted volumes with the <code>Encrypted</code> parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-volume.html">Creating or Restoring an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVolume service method.</param> <returns>The response from the CreateVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVolumeAsync(Amazon.EC2.Model.CreateVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpc(Amazon.EC2.Model.CreateVpcRequest)"> <summary> Creates a VPC with the specified CIDR block. <para> The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <para> By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpc service method.</param> <returns>The response from the CreateVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpcAsync(Amazon.EC2.Model.CreateVpcRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpc operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpcEndpoint(Amazon.EC2.Model.CreateVpcEndpointRequest)"> <summary> Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. <para> Currently, only endpoints to Amazon S3 are supported. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpcEndpoint service method.</param> <returns>The response from the CreateVpcEndpoint service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpcEndpointAsync(Amazon.EC2.Model.CreateVpcEndpointRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVpcEndpoint operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpcEndpoint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpcPeeringConnection(Amazon.EC2.Model.CreateVpcPeeringConnectionRequest)"> <summary> Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks. <para> The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected. </para> <para> A <code>CreateVpcPeeringConnection</code> request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of <code>failed</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpcPeeringConnection service method.</param> <returns>The response from the CreateVpcPeeringConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpcPeeringConnectionAsync(Amazon.EC2.Model.CreateVpcPeeringConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVpcPeeringConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpcPeeringConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpnConnection(Amazon.EC2.Model.CreateVpnConnectionRequest)"> <summary> Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is <code>ipsec.1</code>. <para> The response includes information that you need to give to your network administrator to configure your customer gateway. </para> <important> <para> We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. </para> </important> <para> If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call. </para> <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnConnection service method.</param> <returns>The response from the CreateVpnConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpnConnectionAsync(Amazon.EC2.Model.CreateVpnConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVpnConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpnConnectionRoute(Amazon.EC2.Model.CreateVpnConnectionRouteRequest)"> <summary> Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnConnectionRoute service method.</param> <returns>The response from the CreateVpnConnectionRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpnConnectionRouteAsync(Amazon.EC2.Model.CreateVpnConnectionRouteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVpnConnectionRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnConnectionRoute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpnGateway(Amazon.EC2.Model.CreateVpnGatewayRequest)"> <summary> Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself. <para> For more information about virtual private gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnGateway service method.</param> <returns>The response from the CreateVpnGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpnGatewayAsync(Amazon.EC2.Model.CreateVpnGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVpnGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteCustomerGateway(Amazon.EC2.Model.DeleteCustomerGatewayRequest)"> <summary> Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCustomerGateway service method.</param> <returns>The response from the DeleteCustomerGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteCustomerGatewayAsync(Amazon.EC2.Model.DeleteCustomerGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCustomerGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCustomerGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteDhcpOptions(Amazon.EC2.Model.DeleteDhcpOptionsRequest)"> <summary> Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDhcpOptions service method.</param> <returns>The response from the DeleteDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteDhcpOptionsAsync(Amazon.EC2.Model.DeleteDhcpOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDhcpOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDhcpOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteFlowLogs(Amazon.EC2.Model.DeleteFlowLogsRequest)"> <summary> Deletes one or more flow logs. </summary> <param name="request">Container for the necessary parameters to execute the DeleteFlowLogs service method.</param> <returns>The response from the DeleteFlowLogs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteFlowLogsAsync(Amazon.EC2.Model.DeleteFlowLogsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteFlowLogs operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteFlowLogs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteInternetGateway(Amazon.EC2.Model.DeleteInternetGatewayRequest)"> <summary> Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInternetGateway service method.</param> <returns>The response from the DeleteInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteInternetGatewayAsync(Amazon.EC2.Model.DeleteInternetGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteInternetGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInternetGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteKeyPair(Amazon.EC2.Model.DeleteKeyPairRequest)"> <summary> Deletes the specified key pair, by removing the public key from Amazon EC2. </summary> <param name="request">Container for the necessary parameters to execute the DeleteKeyPair service method.</param> <returns>The response from the DeleteKeyPair service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteKeyPairAsync(Amazon.EC2.Model.DeleteKeyPairRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteKeyPair operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteKeyPair operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteNetworkAcl(Amazon.EC2.Model.DeleteNetworkAclRequest)"> <summary> Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkAcl service method.</param> <returns>The response from the DeleteNetworkAcl service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteNetworkAclAsync(Amazon.EC2.Model.DeleteNetworkAclRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteNetworkAcl operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkAcl operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteNetworkAclEntry(Amazon.EC2.Model.DeleteNetworkAclEntryRequest)"> <summary> Deletes the specified ingress or egress entry (rule) from the specified network ACL. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkAclEntry service method.</param> <returns>The response from the DeleteNetworkAclEntry service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteNetworkAclEntryAsync(Amazon.EC2.Model.DeleteNetworkAclEntryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteNetworkAclEntry operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkAclEntry operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteNetworkInterface(Amazon.EC2.Model.DeleteNetworkInterfaceRequest)"> <summary> Deletes the specified network interface. You must detach the network interface before you can delete it. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkInterface service method.</param> <returns>The response from the DeleteNetworkInterface service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteNetworkInterfaceAsync(Amazon.EC2.Model.DeleteNetworkInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteNetworkInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeletePlacementGroup(Amazon.EC2.Model.DeletePlacementGroupRequest)"> <summary> Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeletePlacementGroup service method.</param> <returns>The response from the DeletePlacementGroup service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeletePlacementGroupAsync(Amazon.EC2.Model.DeletePlacementGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePlacementGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePlacementGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteRoute(Amazon.EC2.Model.DeleteRouteRequest)"> <summary> Deletes the specified route from the specified route table. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRoute service method.</param> <returns>The response from the DeleteRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteRouteAsync(Amazon.EC2.Model.DeleteRouteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRoute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteRouteTable(Amazon.EC2.Model.DeleteRouteTableRequest)"> <summary> Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRouteTable service method.</param> <returns>The response from the DeleteRouteTable service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteRouteTableAsync(Amazon.EC2.Model.DeleteRouteTableRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRouteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRouteTable operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSecurityGroup(Amazon.EC2.Model.DeleteSecurityGroupRequest)"> <summary> Deletes a security group. <para> If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with <code>InvalidGroup.InUse</code> in EC2-Classic or <code>DependencyViolation</code> in EC2-VPC. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSecurityGroup service method.</param> <returns>The response from the DeleteSecurityGroup service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSecurityGroupAsync(Amazon.EC2.Model.DeleteSecurityGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSecurityGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSnapshot(Amazon.EC2.Model.DeleteSnapshotRequest)"> <summary> Deletes the specified snapshot. <para> When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume. </para> <para> You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-snapshot.html">Deleting an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot service method.</param> <returns>The response from the DeleteSnapshot service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSnapshotAsync(Amazon.EC2.Model.DeleteSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSpotDatafeedSubscription"> <summary> Deletes the data feed for Spot instances. </summary> <returns>The response from the DeleteSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSpotDatafeedSubscription(Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionRequest)"> <summary> Deletes the data feed for Spot instances. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSpotDatafeedSubscription service method.</param> <returns>The response from the DeleteSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSpotDatafeedSubscriptionAsync(Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSpotDatafeedSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSpotDatafeedSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSubnet(Amazon.EC2.Model.DeleteSubnetRequest)"> <summary> Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSubnet service method.</param> <returns>The response from the DeleteSubnet service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSubnetAsync(Amazon.EC2.Model.DeleteSubnetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSubnet operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSubnet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteTags(Amazon.EC2.Model.DeleteTagsRequest)"> <summary> Deletes the specified set of tags from the specified set of resources. This call is designed to follow a <code>DescribeTags</code> request. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags service method.</param> <returns>The response from the DeleteTags service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteTagsAsync(Amazon.EC2.Model.DeleteTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVolume(Amazon.EC2.Model.DeleteVolumeRequest)"> <summary> Deletes the specified EBS volume. The volume must be in the <code>available</code> state (not attached to an instance). <note> <para> The volume may remain in the <code>deleting</code> state for several minutes. </para> </note> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-volume.html">Deleting an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVolume service method.</param> <returns>The response from the DeleteVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVolumeAsync(Amazon.EC2.Model.DeleteVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpc(Amazon.EC2.Model.DeleteVpcRequest)"> <summary> Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpc service method.</param> <returns>The response from the DeleteVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpcAsync(Amazon.EC2.Model.DeleteVpcRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpc operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpcEndpoints(Amazon.EC2.Model.DeleteVpcEndpointsRequest)"> <summary> Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpcEndpoints service method.</param> <returns>The response from the DeleteVpcEndpoints service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpcEndpointsAsync(Amazon.EC2.Model.DeleteVpcEndpointsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVpcEndpoints operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpcEndpoints operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpcPeeringConnection(Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest)"> <summary> Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the <code>active</code> state. The owner of the requester VPC can delete a VPC peering connection in the <code>pending-acceptance</code> state. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpcPeeringConnection service method.</param> <returns>The response from the DeleteVpcPeeringConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpcPeeringConnectionAsync(Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVpcPeeringConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpcPeeringConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpnConnection(Amazon.EC2.Model.DeleteVpnConnectionRequest)"> <summary> Deletes the specified VPN connection. <para> If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnConnection service method.</param> <returns>The response from the DeleteVpnConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpnConnectionAsync(Amazon.EC2.Model.DeleteVpnConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVpnConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpnConnectionRoute(Amazon.EC2.Model.DeleteVpnConnectionRouteRequest)"> <summary> Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnConnectionRoute service method.</param> <returns>The response from the DeleteVpnConnectionRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpnConnectionRouteAsync(Amazon.EC2.Model.DeleteVpnConnectionRouteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVpnConnectionRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnConnectionRoute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpnGateway(Amazon.EC2.Model.DeleteVpnGatewayRequest)"> <summary> Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnGateway service method.</param> <returns>The response from the DeleteVpnGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpnGatewayAsync(Amazon.EC2.Model.DeleteVpnGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVpnGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeregisterImage(Amazon.EC2.Model.DeregisterImageRequest)"> <summary> Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances. <para> This command does not delete the AMI. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterImage service method.</param> <returns>The response from the DeregisterImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeregisterImageAsync(Amazon.EC2.Model.DeregisterImageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterImage operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterImage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAccountAttributes"> <summary> Describes attributes of your AWS account. The following are the supported account attributes: <ul> <li> <para> <code>supported-platforms</code>: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC. </para> </li> <li> <para> <code>default-vpc</code>: The ID of the default VPC for your account, or <code>none</code>. </para> </li> <li> <para> <code>max-instances</code>: The maximum number of On-Demand instances that you can run. </para> </li> <li> <para> <code>vpc-max-security-groups-per-interface</code>: The maximum number of security groups that you can assign to a network interface. </para> </li> <li> <para> <code>max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic. </para> </li> <li> <para> <code>vpc-max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC. </para> </li> </ul> </summary> <returns>The response from the DescribeAccountAttributes service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAccountAttributes(Amazon.EC2.Model.DescribeAccountAttributesRequest)"> <summary> Describes attributes of your AWS account. The following are the supported account attributes: <ul> <li> <para> <code>supported-platforms</code>: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC. </para> </li> <li> <para> <code>default-vpc</code>: The ID of the default VPC for your account, or <code>none</code>. </para> </li> <li> <para> <code>max-instances</code>: The maximum number of On-Demand instances that you can run. </para> </li> <li> <para> <code>vpc-max-security-groups-per-interface</code>: The maximum number of security groups that you can assign to a network interface. </para> </li> <li> <para> <code>max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic. </para> </li> <li> <para> <code>vpc-max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountAttributes service method.</param> <returns>The response from the DescribeAccountAttributes service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAccountAttributesAsync(Amazon.EC2.Model.DescribeAccountAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAccountAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAddresses"> <summary> Describes one or more of your Elastic IP addresses. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAddresses(Amazon.EC2.Model.DescribeAddressesRequest)"> <summary> Describes one or more of your Elastic IP addresses. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAddresses service method.</param> <returns>The response from the DescribeAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAddressesAsync(Amazon.EC2.Model.DescribeAddressesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAddresses operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAvailabilityZones"> <summary> Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html">Regions and Availability Zones</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeAvailabilityZones service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAvailabilityZones(Amazon.EC2.Model.DescribeAvailabilityZonesRequest)"> <summary> Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html">Regions and Availability Zones</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityZones service method.</param> <returns>The response from the DescribeAvailabilityZones service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAvailabilityZonesAsync(Amazon.EC2.Model.DescribeAvailabilityZonesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAvailabilityZones operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityZones operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeBundleTasks"> <summary> Describes one or more of your bundling tasks. <note> <para> Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided to the bundle task. </para> </note> </summary> <returns>The response from the DescribeBundleTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeBundleTasks(Amazon.EC2.Model.DescribeBundleTasksRequest)"> <summary> Describes one or more of your bundling tasks. <note> <para> Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided to the bundle task. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeBundleTasks service method.</param> <returns>The response from the DescribeBundleTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeBundleTasksAsync(Amazon.EC2.Model.DescribeBundleTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeBundleTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeBundleTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeClassicLinkInstances(Amazon.EC2.Model.DescribeClassicLinkInstancesRequest)"> <summary> Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClassicLinkInstances service method.</param> <returns>The response from the DescribeClassicLinkInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeClassicLinkInstancesAsync(Amazon.EC2.Model.DescribeClassicLinkInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClassicLinkInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClassicLinkInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeConversionTasks"> <summary> Describes one or more of your conversion tasks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <returns>The response from the DescribeConversionTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeConversionTasks(Amazon.EC2.Model.DescribeConversionTasksRequest)"> <summary> Describes one or more of your conversion tasks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConversionTasks service method.</param> <returns>The response from the DescribeConversionTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeConversionTasksAsync(Amazon.EC2.Model.DescribeConversionTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConversionTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConversionTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeCustomerGateways"> <summary> Describes one or more of your VPN customer gateways. <para> For more information about VPN customer gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeCustomerGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeCustomerGateways(Amazon.EC2.Model.DescribeCustomerGatewaysRequest)"> <summary> Describes one or more of your VPN customer gateways. <para> For more information about VPN customer gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCustomerGateways service method.</param> <returns>The response from the DescribeCustomerGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeCustomerGatewaysAsync(Amazon.EC2.Model.DescribeCustomerGatewaysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCustomerGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCustomerGateways operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeDhcpOptions"> <summary> Describes one or more of your DHCP options sets. <para> For more information about DHCP options sets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeDhcpOptions(Amazon.EC2.Model.DescribeDhcpOptionsRequest)"> <summary> Describes one or more of your DHCP options sets. <para> For more information about DHCP options sets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDhcpOptions service method.</param> <returns>The response from the DescribeDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeDhcpOptionsAsync(Amazon.EC2.Model.DescribeDhcpOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDhcpOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDhcpOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeExportTasks"> <summary> Describes one or more of your export tasks. </summary> <returns>The response from the DescribeExportTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeExportTasks(Amazon.EC2.Model.DescribeExportTasksRequest)"> <summary> Describes one or more of your export tasks. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExportTasks service method.</param> <returns>The response from the DescribeExportTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeExportTasksAsync(Amazon.EC2.Model.DescribeExportTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeExportTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExportTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeFlowLogs(Amazon.EC2.Model.DescribeFlowLogsRequest)"> <summary> Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API. </summary> <param name="request">Container for the necessary parameters to execute the DescribeFlowLogs service method.</param> <returns>The response from the DescribeFlowLogs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeFlowLogsAsync(Amazon.EC2.Model.DescribeFlowLogsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeFlowLogs operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeFlowLogs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeImageAttribute(Amazon.EC2.Model.DescribeImageAttributeRequest)"> <summary> Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImageAttribute service method.</param> <returns>The response from the DescribeImageAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeImageAttributeAsync(Amazon.EC2.Model.DescribeImageAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeImageAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImageAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeImages"> <summary> Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions. <note> <para> Deregistered images are included in the returned results for an unspecified interval after deregistration. </para> </note> </summary> <returns>The response from the DescribeImages service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeImages(Amazon.EC2.Model.DescribeImagesRequest)"> <summary> Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions. <note> <para> Deregistered images are included in the returned results for an unspecified interval after deregistration. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeImages service method.</param> <returns>The response from the DescribeImages service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeImagesAsync(Amazon.EC2.Model.DescribeImagesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeImages operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImages operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeImportImageTasks(Amazon.EC2.Model.DescribeImportImageTasksRequest)"> <summary> Displays details about an import virtual machine or import snapshot tasks that are already created. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImportImageTasks service method.</param> <returns>The response from the DescribeImportImageTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeImportImageTasksAsync(Amazon.EC2.Model.DescribeImportImageTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeImportImageTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImportImageTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeImportSnapshotTasks(Amazon.EC2.Model.DescribeImportSnapshotTasksRequest)"> <summary> Describes your import snapshot tasks. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImportSnapshotTasks service method.</param> <returns>The response from the DescribeImportSnapshotTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeImportSnapshotTasksAsync(Amazon.EC2.Model.DescribeImportSnapshotTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeImportSnapshotTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImportSnapshotTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInstanceAttribute(Amazon.EC2.Model.DescribeInstanceAttributeRequest)"> <summary> Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: <code>instanceType</code> | <code>kernel</code> | <code>ramdisk</code> | <code>userData</code> | <code>disableApiTermination</code> | <code>instanceInitiatedShutdownBehavior</code> | <code>rootDeviceName</code> | <code>blockDeviceMapping</code> | <code>productCodes</code> | <code>sourceDestCheck</code> | <code>groupSet</code> | <code>ebsOptimized</code> | <code>sriovNetSupport</code> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceAttribute service method.</param> <returns>The response from the DescribeInstanceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInstanceAttributeAsync(Amazon.EC2.Model.DescribeInstanceAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInstanceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInstances"> <summary> Describes one or more of your instances. <para> If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results. </para> <para> Recently terminated instances might appear in the returned results. This interval is usually less than one hour. </para> </summary> <returns>The response from the DescribeInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInstances(Amazon.EC2.Model.DescribeInstancesRequest)"> <summary> Describes one or more of your instances. <para> If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results. </para> <para> Recently terminated instances might appear in the returned results. This interval is usually less than one hour. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstances service method.</param> <returns>The response from the DescribeInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInstancesAsync(Amazon.EC2.Model.DescribeInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInstanceStatus"> <summary> Describes the status of one or more instances. <para> Instance status includes the following components: </para> <ul> <li> <para> <b>Status checks</b> - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html">Status Checks for Your Instances</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html">Troubleshooting Instances with Failed Status Checks</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Scheduled events</b> - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html">Scheduled Events for Your Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Instance state</b> - You can manage your instances from the moment you launch them through their termination. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> </ul> </summary> <returns>The response from the DescribeInstanceStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInstanceStatus(Amazon.EC2.Model.DescribeInstanceStatusRequest)"> <summary> Describes the status of one or more instances. <para> Instance status includes the following components: </para> <ul> <li> <para> <b>Status checks</b> - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html">Status Checks for Your Instances</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html">Troubleshooting Instances with Failed Status Checks</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Scheduled events</b> - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html">Scheduled Events for Your Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Instance state</b> - You can manage your instances from the moment you launch them through their termination. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceStatus service method.</param> <returns>The response from the DescribeInstanceStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInstanceStatusAsync(Amazon.EC2.Model.DescribeInstanceStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInstanceStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInternetGateways"> <summary> Describes one or more of your Internet gateways. </summary> <returns>The response from the DescribeInternetGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInternetGateways(Amazon.EC2.Model.DescribeInternetGatewaysRequest)"> <summary> Describes one or more of your Internet gateways. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInternetGateways service method.</param> <returns>The response from the DescribeInternetGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInternetGatewaysAsync(Amazon.EC2.Model.DescribeInternetGatewaysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInternetGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInternetGateways operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeKeyPairs"> <summary> Describes one or more of your key pairs. <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeKeyPairs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeKeyPairs(Amazon.EC2.Model.DescribeKeyPairsRequest)"> <summary> Describes one or more of your key pairs. <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeKeyPairs service method.</param> <returns>The response from the DescribeKeyPairs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeKeyPairsAsync(Amazon.EC2.Model.DescribeKeyPairsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeKeyPairs operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeKeyPairs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeMovingAddresses(Amazon.EC2.Model.DescribeMovingAddressesRequest)"> <summary> Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMovingAddresses service method.</param> <returns>The response from the DescribeMovingAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeMovingAddressesAsync(Amazon.EC2.Model.DescribeMovingAddressesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeMovingAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMovingAddresses operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeNetworkAcls"> <summary> Describes one or more of your network ACLs. <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeNetworkAcls service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeNetworkAcls(Amazon.EC2.Model.DescribeNetworkAclsRequest)"> <summary> Describes one or more of your network ACLs. <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkAcls service method.</param> <returns>The response from the DescribeNetworkAcls service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeNetworkAclsAsync(Amazon.EC2.Model.DescribeNetworkAclsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeNetworkAcls operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkAcls operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeNetworkInterfaceAttribute(Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest)"> <summary> Describes a network interface attribute. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkInterfaceAttribute service method.</param> <returns>The response from the DescribeNetworkInterfaceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeNetworkInterfaceAttributeAsync(Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeNetworkInterfaceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkInterfaceAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeNetworkInterfaces"> <summary> Describes one or more of your network interfaces. </summary> <returns>The response from the DescribeNetworkInterfaces service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeNetworkInterfaces(Amazon.EC2.Model.DescribeNetworkInterfacesRequest)"> <summary> Describes one or more of your network interfaces. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkInterfaces service method.</param> <returns>The response from the DescribeNetworkInterfaces service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeNetworkInterfacesAsync(Amazon.EC2.Model.DescribeNetworkInterfacesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeNetworkInterfaces operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkInterfaces operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribePlacementGroups"> <summary> Describes one or more of your placement groups. For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <returns>The response from the DescribePlacementGroups service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribePlacementGroups(Amazon.EC2.Model.DescribePlacementGroupsRequest)"> <summary> Describes one or more of your placement groups. For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribePlacementGroups service method.</param> <returns>The response from the DescribePlacementGroups service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribePlacementGroupsAsync(Amazon.EC2.Model.DescribePlacementGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribePlacementGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePlacementGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribePrefixLists(Amazon.EC2.Model.DescribePrefixListsRequest)"> <summary> Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a VPC endpoint. </summary> <param name="request">Container for the necessary parameters to execute the DescribePrefixLists service method.</param> <returns>The response from the DescribePrefixLists service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribePrefixListsAsync(Amazon.EC2.Model.DescribePrefixListsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribePrefixLists operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePrefixLists operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeRegions"> <summary> Describes one or more regions that are currently available to you. <para> For a list of the regions supported by Amazon EC2, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region">Regions and Endpoints</a>. </para> </summary> <returns>The response from the DescribeRegions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeRegions(Amazon.EC2.Model.DescribeRegionsRequest)"> <summary> Describes one or more regions that are currently available to you. <para> For a list of the regions supported by Amazon EC2, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region">Regions and Endpoints</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeRegions service method.</param> <returns>The response from the DescribeRegions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeRegionsAsync(Amazon.EC2.Model.DescribeRegionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeRegions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRegions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstances"> <summary> Describes one or more of the Reserved Instances that you purchased. <para> For more information about Reserved Instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeReservedInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstances(Amazon.EC2.Model.DescribeReservedInstancesRequest)"> <summary> Describes one or more of the Reserved Instances that you purchased. <para> For more information about Reserved Instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstances service method.</param> <returns>The response from the DescribeReservedInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesAsync(Amazon.EC2.Model.DescribeReservedInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesListings"> <summary> Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. <para> The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. </para> <para> As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase. </para> <para> As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeReservedInstancesListings service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesListings(Amazon.EC2.Model.DescribeReservedInstancesListingsRequest)"> <summary> Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. <para> The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. </para> <para> As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase. </para> <para> As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesListings service method.</param> <returns>The response from the DescribeReservedInstancesListings service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesListingsAsync(Amazon.EC2.Model.DescribeReservedInstancesListingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedInstancesListings operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesListings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesModifications"> <summary> Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> <returns>The response from the DescribeReservedInstancesModifications service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesModifications(Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest)"> <summary> Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesModifications service method.</param> <returns>The response from the DescribeReservedInstancesModifications service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesModificationsAsync(Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedInstancesModifications operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesModifications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesOfferings"> <summary> Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeReservedInstancesOfferings service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesOfferings(Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest)"> <summary> Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesOfferings service method.</param> <returns>The response from the DescribeReservedInstancesOfferings service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesOfferingsAsync(Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedInstancesOfferings operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesOfferings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeRouteTables"> <summary> Describes one or more of your route tables. <para> Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations. </para> <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeRouteTables service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeRouteTables(Amazon.EC2.Model.DescribeRouteTablesRequest)"> <summary> Describes one or more of your route tables. <para> Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations. </para> <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeRouteTables service method.</param> <returns>The response from the DescribeRouteTables service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeRouteTablesAsync(Amazon.EC2.Model.DescribeRouteTablesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeRouteTables operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRouteTables operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSecurityGroups"> <summary> Describes one or more of your security groups. <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeSecurityGroups service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSecurityGroups(Amazon.EC2.Model.DescribeSecurityGroupsRequest)"> <summary> Describes one or more of your security groups. <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSecurityGroups service method.</param> <returns>The response from the DescribeSecurityGroups service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSecurityGroupsAsync(Amazon.EC2.Model.DescribeSecurityGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSecurityGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSecurityGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSnapshotAttribute(Amazon.EC2.Model.DescribeSnapshotAttributeRequest)"> <summary> Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time. <para> For more information about EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshotAttribute service method.</param> <returns>The response from the DescribeSnapshotAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSnapshotAttributeAsync(Amazon.EC2.Model.DescribeSnapshotAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSnapshotAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshotAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSnapshots"> <summary> Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions. <para> The create volume permissions fall into the following categories: </para> <ul> <li> <i>public</i>: The owner of the snapshot granted create volume permissions for the snapshot to the <code>all</code> group. All AWS accounts have create volume permissions for these snapshots.</li> <li> <i>explicit</i>: The owner of the snapshot granted create volume permissions to a specific AWS account.</li> <li> <i>implicit</i>: An AWS account has implicit create volume permissions for all snapshots it owns.</li> </ul> <para> The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. </para> <para> If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results. </para> <para> If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, <code>amazon</code> for snapshots owned by Amazon, or <code>self</code> for snapshots that you own. </para> <para> If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), <code>self</code> for snapshots for which you own or have explicit permissions, or <code>all</code> for public snapshots. </para> <para> If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSnapshots</code> request to retrieve the remaining results. </para> <para> For more information about EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeSnapshots service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSnapshots(Amazon.EC2.Model.DescribeSnapshotsRequest)"> <summary> Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions. <para> The create volume permissions fall into the following categories: </para> <ul> <li> <i>public</i>: The owner of the snapshot granted create volume permissions for the snapshot to the <code>all</code> group. All AWS accounts have create volume permissions for these snapshots.</li> <li> <i>explicit</i>: The owner of the snapshot granted create volume permissions to a specific AWS account.</li> <li> <i>implicit</i>: An AWS account has implicit create volume permissions for all snapshots it owns.</li> </ul> <para> The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. </para> <para> If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results. </para> <para> If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, <code>amazon</code> for snapshots owned by Amazon, or <code>self</code> for snapshots that you own. </para> <para> If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), <code>self</code> for snapshots for which you own or have explicit permissions, or <code>all</code> for public snapshots. </para> <para> If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSnapshots</code> request to retrieve the remaining results. </para> <para> For more information about EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots service method.</param> <returns>The response from the DescribeSnapshots service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSnapshotsAsync(Amazon.EC2.Model.DescribeSnapshotsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSnapshots operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotDatafeedSubscription"> <summary> Describes the data feed for Spot instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <returns>The response from the DescribeSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotDatafeedSubscription(Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionRequest)"> <summary> Describes the data feed for Spot instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotDatafeedSubscription service method.</param> <returns>The response from the DescribeSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotDatafeedSubscriptionAsync(Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSpotDatafeedSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotDatafeedSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotFleetInstances(Amazon.EC2.Model.DescribeSpotFleetInstancesRequest)"> <summary> Describes the running instances for the specified Spot fleet. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetInstances service method.</param> <returns>The response from the DescribeSpotFleetInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotFleetInstancesAsync(Amazon.EC2.Model.DescribeSpotFleetInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSpotFleetInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotFleetRequestHistory(Amazon.EC2.Model.DescribeSpotFleetRequestHistoryRequest)"> <summary> Describes the events for the specified Spot fleet request during the specified time. <para> Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetRequestHistory service method.</param> <returns>The response from the DescribeSpotFleetRequestHistory service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotFleetRequestHistoryAsync(Amazon.EC2.Model.DescribeSpotFleetRequestHistoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSpotFleetRequestHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetRequestHistory operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotFleetRequests(Amazon.EC2.Model.DescribeSpotFleetRequestsRequest)"> <summary> Describes your Spot fleet requests. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetRequests service method.</param> <returns>The response from the DescribeSpotFleetRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotFleetRequestsAsync(Amazon.EC2.Model.DescribeSpotFleetRequestsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSpotFleetRequests operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetRequests operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotInstanceRequests"> <summary> Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> You can use <code>DescribeSpotInstanceRequests</code> to find a running Spot instance by examining the response. If the status of the Spot instance is <code>fulfilled</code>, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use <a>DescribeInstances</a> with a filter to look for instances where the instance lifecycle is <code>spot</code>. </para> </summary> <returns>The response from the DescribeSpotInstanceRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotInstanceRequests(Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest)"> <summary> Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> You can use <code>DescribeSpotInstanceRequests</code> to find a running Spot instance by examining the response. If the status of the Spot instance is <code>fulfilled</code>, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use <a>DescribeInstances</a> with a filter to look for instances where the instance lifecycle is <code>spot</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotInstanceRequests service method.</param> <returns>The response from the DescribeSpotInstanceRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotInstanceRequestsAsync(Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSpotInstanceRequests operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotInstanceRequests operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotPriceHistory"> <summary> Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html">Spot Instance Pricing History</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed. </para> </summary> <returns>The response from the DescribeSpotPriceHistory service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotPriceHistory(Amazon.EC2.Model.DescribeSpotPriceHistoryRequest)"> <summary> Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html">Spot Instance Pricing History</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotPriceHistory service method.</param> <returns>The response from the DescribeSpotPriceHistory service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotPriceHistoryAsync(Amazon.EC2.Model.DescribeSpotPriceHistoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSpotPriceHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotPriceHistory operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSubnets"> <summary> Describes one or more of your subnets. <para> For more information about subnets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeSubnets service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSubnets(Amazon.EC2.Model.DescribeSubnetsRequest)"> <summary> Describes one or more of your subnets. <para> For more information about subnets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSubnets service method.</param> <returns>The response from the DescribeSubnets service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSubnetsAsync(Amazon.EC2.Model.DescribeSubnetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSubnets operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSubnets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeTags"> <summary> Describes one or more of the tags for your EC2 resources. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeTags service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeTags(Amazon.EC2.Model.DescribeTagsRequest)"> <summary> Describes one or more of the tags for your EC2 resources. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags service method.</param> <returns>The response from the DescribeTags service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeTagsAsync(Amazon.EC2.Model.DescribeTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVolumeAttribute(Amazon.EC2.Model.DescribeVolumeAttributeRequest)"> <summary> Describes the specified attribute of the specified volume. You can specify only one attribute at a time. <para> For more information about EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumeAttribute service method.</param> <returns>The response from the DescribeVolumeAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVolumeAttributeAsync(Amazon.EC2.Model.DescribeVolumeAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVolumeAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumeAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVolumes"> <summary> Describes the specified EBS volumes. <para> If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeVolumes</code> request to retrieve the remaining results. </para> <para> For more information about EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeVolumes service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVolumes(Amazon.EC2.Model.DescribeVolumesRequest)"> <summary> Describes the specified EBS volumes. <para> If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeVolumes</code> request to retrieve the remaining results. </para> <para> For more information about EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumes service method.</param> <returns>The response from the DescribeVolumes service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVolumesAsync(Amazon.EC2.Model.DescribeVolumesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVolumes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVolumeStatus"> <summary> Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event. <para> The <code>DescribeVolumeStatus</code> operation provides the following information about the specified volumes: </para> <para> <i>Status</i>: Reflects the current status of the volume. The possible values are <code>ok</code>, <code>impaired</code> , <code>warning</code>, or <code>insufficient-data</code>. If all checks pass, the overall status of the volume is <code>ok</code>. If the check fails, the overall status is <code>impaired</code>. If the status is <code>insufficient-data</code>, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html">Monitoring the Status of Your Volumes</a>. </para> <para> <i>Events</i>: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an <code>impaired</code> status, then the volume event might be <code>potential-data-inconsistency</code>. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data. </para> <para> <i>Actions</i>: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is <code>impaired</code> and the volume event shows <code>potential-data-inconsistency</code>, then the action shows <code>enable-volume-io</code>. This means that you may want to enable the I/O operations for the volume by calling the <a>EnableVolumeIO</a> action and then check the volume for data consistency. </para> <note> <para> Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the <code>error</code> state (for example, when a volume is incapable of accepting I/O.) </para> </note> </summary> <returns>The response from the DescribeVolumeStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVolumeStatus(Amazon.EC2.Model.DescribeVolumeStatusRequest)"> <summary> Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event. <para> The <code>DescribeVolumeStatus</code> operation provides the following information about the specified volumes: </para> <para> <i>Status</i>: Reflects the current status of the volume. The possible values are <code>ok</code>, <code>impaired</code> , <code>warning</code>, or <code>insufficient-data</code>. If all checks pass, the overall status of the volume is <code>ok</code>. If the check fails, the overall status is <code>impaired</code>. If the status is <code>insufficient-data</code>, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html">Monitoring the Status of Your Volumes</a>. </para> <para> <i>Events</i>: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an <code>impaired</code> status, then the volume event might be <code>potential-data-inconsistency</code>. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data. </para> <para> <i>Actions</i>: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is <code>impaired</code> and the volume event shows <code>potential-data-inconsistency</code>, then the action shows <code>enable-volume-io</code>. This means that you may want to enable the I/O operations for the volume by calling the <a>EnableVolumeIO</a> action and then check the volume for data consistency. </para> <note> <para> Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the <code>error</code> state (for example, when a volume is incapable of accepting I/O.) </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumeStatus service method.</param> <returns>The response from the DescribeVolumeStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVolumeStatusAsync(Amazon.EC2.Model.DescribeVolumeStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVolumeStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumeStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcAttribute(Amazon.EC2.Model.DescribeVpcAttributeRequest)"> <summary> Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcAttribute service method.</param> <returns>The response from the DescribeVpcAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcAttributeAsync(Amazon.EC2.Model.DescribeVpcAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVpcAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcClassicLink(Amazon.EC2.Model.DescribeVpcClassicLinkRequest)"> <summary> Describes the ClassicLink status of one or more VPCs. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcClassicLink service method.</param> <returns>The response from the DescribeVpcClassicLink service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcClassicLinkAsync(Amazon.EC2.Model.DescribeVpcClassicLinkRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVpcClassicLink operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcClassicLink operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcEndpoints(Amazon.EC2.Model.DescribeVpcEndpointsRequest)"> <summary> Describes one or more of your VPC endpoints. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcEndpoints service method.</param> <returns>The response from the DescribeVpcEndpoints service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcEndpointsAsync(Amazon.EC2.Model.DescribeVpcEndpointsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVpcEndpoints operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcEndpoints operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcEndpointServices(Amazon.EC2.Model.DescribeVpcEndpointServicesRequest)"> <summary> Describes all supported AWS services that can be specified when creating a VPC endpoint. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcEndpointServices service method.</param> <returns>The response from the DescribeVpcEndpointServices service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcEndpointServicesAsync(Amazon.EC2.Model.DescribeVpcEndpointServicesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVpcEndpointServices operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcEndpointServices operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcPeeringConnections"> <summary> Describes one or more of your VPC peering connections. </summary> <returns>The response from the DescribeVpcPeeringConnections service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcPeeringConnections(Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest)"> <summary> Describes one or more of your VPC peering connections. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcPeeringConnections service method.</param> <returns>The response from the DescribeVpcPeeringConnections service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcPeeringConnectionsAsync(Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVpcPeeringConnections operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcPeeringConnections operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcs"> <summary> Describes one or more of your VPCs. </summary> <returns>The response from the DescribeVpcs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcs(Amazon.EC2.Model.DescribeVpcsRequest)"> <summary> Describes one or more of your VPCs. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcs service method.</param> <returns>The response from the DescribeVpcs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcsAsync(Amazon.EC2.Model.DescribeVpcsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVpcs operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpnConnections"> <summary> Describes one or more of your VPN connections. <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeVpnConnections service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpnConnections(Amazon.EC2.Model.DescribeVpnConnectionsRequest)"> <summary> Describes one or more of your VPN connections. <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpnConnections service method.</param> <returns>The response from the DescribeVpnConnections service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpnConnectionsAsync(Amazon.EC2.Model.DescribeVpnConnectionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVpnConnections operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpnConnections operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpnGateways"> <summary> Describes one or more of your virtual private gateways. <para> For more information about virtual private gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding an IPsec Hardware VPN to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeVpnGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpnGateways(Amazon.EC2.Model.DescribeVpnGatewaysRequest)"> <summary> Describes one or more of your virtual private gateways. <para> For more information about virtual private gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding an IPsec Hardware VPN to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpnGateways service method.</param> <returns>The response from the DescribeVpnGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpnGatewaysAsync(Amazon.EC2.Model.DescribeVpnGatewaysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVpnGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpnGateways operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachClassicLinkVpc(Amazon.EC2.Model.DetachClassicLinkVpcRequest)"> <summary> Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped. </summary> <param name="request">Container for the necessary parameters to execute the DetachClassicLinkVpc service method.</param> <returns>The response from the DetachClassicLinkVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachClassicLinkVpcAsync(Amazon.EC2.Model.DetachClassicLinkVpcRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachClassicLinkVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachClassicLinkVpc operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachInternetGateway(Amazon.EC2.Model.DetachInternetGatewayRequest)"> <summary> Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses. </summary> <param name="request">Container for the necessary parameters to execute the DetachInternetGateway service method.</param> <returns>The response from the DetachInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachInternetGatewayAsync(Amazon.EC2.Model.DetachInternetGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachInternetGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachInternetGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachNetworkInterface(Amazon.EC2.Model.DetachNetworkInterfaceRequest)"> <summary> Detaches a network interface from an instance. </summary> <param name="request">Container for the necessary parameters to execute the DetachNetworkInterface service method.</param> <returns>The response from the DetachNetworkInterface service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachNetworkInterfaceAsync(Amazon.EC2.Model.DetachNetworkInterfaceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachNetworkInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachNetworkInterface operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachVolume(Amazon.EC2.Model.DetachVolumeRequest)"> <summary> Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching. <para> If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first. </para> <para> When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-detaching-volume.html">Detaching an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachVolume service method.</param> <returns>The response from the DetachVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachVolumeAsync(Amazon.EC2.Model.DetachVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachVpnGateway(Amazon.EC2.Model.DetachVpnGatewayRequest)"> <summary> Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described). <para> You must wait for the attachment's state to switch to <code>detached</code> before you can delete the VPC or attach a different VPC to the virtual private gateway. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachVpnGateway service method.</param> <returns>The response from the DetachVpnGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachVpnGatewayAsync(Amazon.EC2.Model.DetachVpnGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachVpnGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachVpnGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DisableVgwRoutePropagation(Amazon.EC2.Model.DisableVgwRoutePropagationRequest)"> <summary> Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC. </summary> <param name="request">Container for the necessary parameters to execute the DisableVgwRoutePropagation service method.</param> <returns>The response from the DisableVgwRoutePropagation service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DisableVgwRoutePropagationAsync(Amazon.EC2.Model.DisableVgwRoutePropagationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableVgwRoutePropagation operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableVgwRoutePropagation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DisableVpcClassicLink(Amazon.EC2.Model.DisableVpcClassicLinkRequest)"> <summary> Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it. </summary> <param name="request">Container for the necessary parameters to execute the DisableVpcClassicLink service method.</param> <returns>The response from the DisableVpcClassicLink service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DisableVpcClassicLinkAsync(Amazon.EC2.Model.DisableVpcClassicLinkRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableVpcClassicLink operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableVpcClassicLink operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DisassociateAddress(Amazon.EC2.Model.DisassociateAddressRequest)"> <summary> Disassociates an Elastic IP address from the instance or network interface it's associated with. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. </para> </summary> <param name="request">Container for the necessary parameters to execute the DisassociateAddress service method.</param> <returns>The response from the DisassociateAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DisassociateAddressAsync(Amazon.EC2.Model.DisassociateAddressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisassociateAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the DisassociateAddress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DisassociateRouteTable(Amazon.EC2.Model.DisassociateRouteTableRequest)"> <summary> Disassociates a subnet from a route table. <para> After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DisassociateRouteTable service method.</param> <returns>The response from the DisassociateRouteTable service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DisassociateRouteTableAsync(Amazon.EC2.Model.DisassociateRouteTableRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisassociateRouteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the DisassociateRouteTable operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EnableVgwRoutePropagation(Amazon.EC2.Model.EnableVgwRoutePropagationRequest)"> <summary> Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC. </summary> <param name="request">Container for the necessary parameters to execute the EnableVgwRoutePropagation service method.</param> <returns>The response from the EnableVgwRoutePropagation service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EnableVgwRoutePropagationAsync(Amazon.EC2.Model.EnableVgwRoutePropagationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableVgwRoutePropagation operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableVgwRoutePropagation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EnableVolumeIO(Amazon.EC2.Model.EnableVolumeIORequest)"> <summary> Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent. </summary> <param name="request">Container for the necessary parameters to execute the EnableVolumeIO service method.</param> <returns>The response from the EnableVolumeIO service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EnableVolumeIOAsync(Amazon.EC2.Model.EnableVolumeIORequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableVolumeIO operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableVolumeIO operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EnableVpcClassicLink(Amazon.EC2.Model.EnableVpcClassicLinkRequest)"> <summary> Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the <code>10.0.0.0/8</code> IP address range, excluding local routes for VPCs in the <code>10.0.0.0/16</code> and <code>10.1.0.0/16</code> IP address ranges. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the Amazon Elastic Compute Cloud User Guide. </summary> <param name="request">Container for the necessary parameters to execute the EnableVpcClassicLink service method.</param> <returns>The response from the EnableVpcClassicLink service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EnableVpcClassicLinkAsync(Amazon.EC2.Model.EnableVpcClassicLinkRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableVpcClassicLink operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableVpcClassicLink operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.GetConsoleOutput(Amazon.EC2.Model.GetConsoleOutputRequest)"> <summary> Gets the console output for the specified instance. <para> Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface. </para> <para> Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post. </para> <para> For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it. </para> <para> For Windows instances, the instance console output includes output from the EC2Config service. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetConsoleOutput service method.</param> <returns>The response from the GetConsoleOutput service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.GetConsoleOutputAsync(Amazon.EC2.Model.GetConsoleOutputRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetConsoleOutput operation. </summary> <param name="request">Container for the necessary parameters to execute the GetConsoleOutput operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.GetPasswordData(Amazon.EC2.Model.GetPasswordDataRequest)"> <summary> Retrieves the encrypted administrator password for an instance running Windows. <para> The Windows password is generated at boot if the <code>EC2Config</code> service plugin, <code>Ec2SetPassword</code>, is enabled. This usually only happens the first time an AMI is launched, and then <code>Ec2SetPassword</code> is automatically disabled. The password is not generated for rebundled AMIs unless <code>Ec2SetPassword</code> is enabled before bundling. </para> <para> The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file. </para> <para> Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetPasswordData service method.</param> <returns>The response from the GetPasswordData service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.GetPasswordDataAsync(Amazon.EC2.Model.GetPasswordDataRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetPasswordData operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPasswordData operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportImage(Amazon.EC2.Model.ImportImageRequest)"> <summary> Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). </summary> <param name="request">Container for the necessary parameters to execute the ImportImage service method.</param> <returns>The response from the ImportImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportImageAsync(Amazon.EC2.Model.ImportImageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ImportImage operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportImage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportInstance(Amazon.EC2.Model.ImportInstanceRequest)"> <summary> Creates an import instance task using metadata from the specified disk image. <code>ImportInstance</code> only supports single-volume VMs. To import multi-volume VMs, use <a>ImportImage</a>. After importing the image, you then upload it using the <code>ec2-import-volume</code> command in the EC2 command line tools. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ImportInstance service method.</param> <returns>The response from the ImportInstance service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportInstanceAsync(Amazon.EC2.Model.ImportInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ImportInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportKeyPair(Amazon.EC2.Model.ImportKeyPairRequest)"> <summary> Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with <a>CreateKeyPair</a>, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS. <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ImportKeyPair service method.</param> <returns>The response from the ImportKeyPair service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportKeyPairAsync(Amazon.EC2.Model.ImportKeyPairRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ImportKeyPair operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportKeyPair operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportSnapshot(Amazon.EC2.Model.ImportSnapshotRequest)"> <summary> Imports a disk into an EBS snapshot. </summary> <param name="request">Container for the necessary parameters to execute the ImportSnapshot service method.</param> <returns>The response from the ImportSnapshot service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportSnapshotAsync(Amazon.EC2.Model.ImportSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ImportSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportVolume(Amazon.EC2.Model.ImportVolumeRequest)"> <summary> Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the <code>ec2-import-volume</code> command in the Amazon EC2 command-line interface (CLI) tools. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ImportVolume service method.</param> <returns>The response from the ImportVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportVolumeAsync(Amazon.EC2.Model.ImportVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ImportVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyImageAttribute(Amazon.EC2.Model.ModifyImageAttributeRequest)"> <summary> Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. <note> <para> AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ModifyImageAttribute service method.</param> <returns>The response from the ModifyImageAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyImageAttributeAsync(Amazon.EC2.Model.ModifyImageAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyImageAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyImageAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyInstanceAttribute(Amazon.EC2.Model.ModifyInstanceAttributeRequest)"> <summary> Modifies the specified attribute of the specified instance. You can specify only one attribute at a time. <para> To modify some attributes, the instance must be stopped. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingAttributesWhileInstanceStopped.html">Modifying Attributes of a Stopped Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyInstanceAttribute service method.</param> <returns>The response from the ModifyInstanceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyInstanceAttributeAsync(Amazon.EC2.Model.ModifyInstanceAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyInstanceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyInstanceAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyNetworkInterfaceAttribute(Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest)"> <summary> Modifies the specified network interface attribute. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the ModifyNetworkInterfaceAttribute service method.</param> <returns>The response from the ModifyNetworkInterfaceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyNetworkInterfaceAttributeAsync(Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyNetworkInterfaceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyNetworkInterfaceAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyReservedInstances(Amazon.EC2.Model.ModifyReservedInstancesRequest)"> <summary> Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyReservedInstances service method.</param> <returns>The response from the ModifyReservedInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyReservedInstancesAsync(Amazon.EC2.Model.ModifyReservedInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyReservedInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyReservedInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifySnapshotAttribute(Amazon.EC2.Model.ModifySnapshotAttributeRequest)"> <summary> Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls. <para> For more information on modifying snapshot permissions, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html">Sharing Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <note> <para> Snapshots with AWS Marketplace product codes cannot be made public. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ModifySnapshotAttribute service method.</param> <returns>The response from the ModifySnapshotAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifySnapshotAttributeAsync(Amazon.EC2.Model.ModifySnapshotAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifySnapshotAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifySnapshotAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifySubnetAttribute(Amazon.EC2.Model.ModifySubnetAttributeRequest)"> <summary> Modifies a subnet attribute. </summary> <param name="request">Container for the necessary parameters to execute the ModifySubnetAttribute service method.</param> <returns>The response from the ModifySubnetAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifySubnetAttributeAsync(Amazon.EC2.Model.ModifySubnetAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifySubnetAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifySubnetAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyVolumeAttribute(Amazon.EC2.Model.ModifyVolumeAttributeRequest)"> <summary> Modifies a volume attribute. <para> By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume. </para> <para> You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyVolumeAttribute service method.</param> <returns>The response from the ModifyVolumeAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyVolumeAttributeAsync(Amazon.EC2.Model.ModifyVolumeAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyVolumeAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVolumeAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyVpcAttribute(Amazon.EC2.Model.ModifyVpcAttributeRequest)"> <summary> Modifies the specified attribute of the specified VPC. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVpcAttribute service method.</param> <returns>The response from the ModifyVpcAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyVpcAttributeAsync(Amazon.EC2.Model.ModifyVpcAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyVpcAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVpcAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyVpcEndpoint(Amazon.EC2.Model.ModifyVpcEndpointRequest)"> <summary> Modifies attributes of a specified VPC endpoint. You can modify the policy associated with the endpoint, and you can add and remove route tables associated with the endpoint. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVpcEndpoint service method.</param> <returns>The response from the ModifyVpcEndpoint service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyVpcEndpointAsync(Amazon.EC2.Model.ModifyVpcEndpointRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyVpcEndpoint operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVpcEndpoint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.MonitorInstances(Amazon.EC2.Model.MonitorInstancesRequest)"> <summary> Enables monitoring for a running instance. For more information about monitoring instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitoring Your Instances and Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the MonitorInstances service method.</param> <returns>The response from the MonitorInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.MonitorInstancesAsync(Amazon.EC2.Model.MonitorInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the MonitorInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the MonitorInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.MoveAddressToVpc(Amazon.EC2.Model.MoveAddressToVpcRequest)"> <summary> Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the <a>RestoreAddressToClassic</a> request. You cannot move an Elastic IP address that's allocated for use in the EC2-VPC platform to the EC2-Classic platform. </summary> <param name="request">Container for the necessary parameters to execute the MoveAddressToVpc service method.</param> <returns>The response from the MoveAddressToVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.MoveAddressToVpcAsync(Amazon.EC2.Model.MoveAddressToVpcRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the MoveAddressToVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the MoveAddressToVpc operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.PurchaseReservedInstancesOffering(Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest)"> <summary> Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time and pay a lower hourly rate compared to on-Demand Instance pricing. <para> Use <a>DescribeReservedInstancesOfferings</a> to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with <a>DescribeReservedInstances</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedInstancesOffering service method.</param> <returns>The response from the PurchaseReservedInstancesOffering service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.PurchaseReservedInstancesOfferingAsync(Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PurchaseReservedInstancesOffering operation. </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedInstancesOffering operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RebootInstances(Amazon.EC2.Model.RebootInstancesRequest)"> <summary> Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. <para> If a Linux/Unix instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html">Getting Console Output and Rebooting Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RebootInstances service method.</param> <returns>The response from the RebootInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RebootInstancesAsync(Amazon.EC2.Model.RebootInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RebootInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the RebootInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RegisterImage(Amazon.EC2.Model.RegisterImageRequest)"> <summary> Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html">Creating Your Own AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <note> <para> For Amazon EBS-backed instances, <a>CreateImage</a> creates and registers the AMI in a single request, so you don't have to register the AMI yourself. </para> </note> <para> You can also use <code>RegisterImage</code> to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_LaunchingInstanceFromSnapshot.html">Launching an Instance from a Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <important> <para> Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 <code>billingProduct</code> code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure. </para> <para> Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI. </para> <para> To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see <a>CreateImage</a>. </para> </important> <para> If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image. </para> <note> <para> You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the RegisterImage service method.</param> <returns>The response from the RegisterImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RegisterImageAsync(Amazon.EC2.Model.RegisterImageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterImage operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterImage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RejectVpcPeeringConnection(Amazon.EC2.Model.RejectVpcPeeringConnectionRequest)"> <summary> Rejects a VPC peering connection request. The VPC peering connection must be in the <code>pending-acceptance</code> state. Use the <a>DescribeVpcPeeringConnections</a> request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use <a>DeleteVpcPeeringConnection</a>. </summary> <param name="request">Container for the necessary parameters to execute the RejectVpcPeeringConnection service method.</param> <returns>The response from the RejectVpcPeeringConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RejectVpcPeeringConnectionAsync(Amazon.EC2.Model.RejectVpcPeeringConnectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RejectVpcPeeringConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the RejectVpcPeeringConnection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReleaseAddress(Amazon.EC2.Model.ReleaseAddressRequest)"> <summary> Releases the specified Elastic IP address. <para> After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an <code>AuthFailure</code> error if the address is already allocated to another AWS account. </para> <para> [EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use <a>DisassociateAddress</a>. </para> <para> [Nondefault VPC] You must use <a>DisassociateAddress</a> to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (<code>InvalidIPAddress.InUse</code>). </para> </summary> <param name="request">Container for the necessary parameters to execute the ReleaseAddress service method.</param> <returns>The response from the ReleaseAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReleaseAddressAsync(Amazon.EC2.Model.ReleaseAddressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReleaseAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the ReleaseAddress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReplaceNetworkAclAssociation(Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest)"> <summary> Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceNetworkAclAssociation service method.</param> <returns>The response from the ReplaceNetworkAclAssociation service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReplaceNetworkAclAssociationAsync(Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReplaceNetworkAclAssociation operation. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceNetworkAclAssociation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReplaceNetworkAclEntry(Amazon.EC2.Model.ReplaceNetworkAclEntryRequest)"> <summary> Replaces an entry (rule) in a network ACL. For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceNetworkAclEntry service method.</param> <returns>The response from the ReplaceNetworkAclEntry service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReplaceNetworkAclEntryAsync(Amazon.EC2.Model.ReplaceNetworkAclEntryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReplaceNetworkAclEntry operation. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceNetworkAclEntry operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReplaceRoute(Amazon.EC2.Model.ReplaceRouteRequest)"> <summary> Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReplaceRoute service method.</param> <returns>The response from the ReplaceRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReplaceRouteAsync(Amazon.EC2.Model.ReplaceRouteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReplaceRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceRoute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReplaceRouteTableAssociation(Amazon.EC2.Model.ReplaceRouteTableAssociationRequest)"> <summary> Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. <para> You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReplaceRouteTableAssociation service method.</param> <returns>The response from the ReplaceRouteTableAssociation service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReplaceRouteTableAssociationAsync(Amazon.EC2.Model.ReplaceRouteTableAssociationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReplaceRouteTableAssociation operation. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceRouteTableAssociation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReportInstanceStatus(Amazon.EC2.Model.ReportInstanceStatusRequest)"> <summary> Submits feedback about the status of an instance. The instance must be in the <code>running</code> state. If your experience with the instance differs from the instance status returned by <a>DescribeInstanceStatus</a>, use <a>ReportInstanceStatus</a> to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. <para> Use of this action does not change the value returned by <a>DescribeInstanceStatus</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReportInstanceStatus service method.</param> <returns>The response from the ReportInstanceStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReportInstanceStatusAsync(Amazon.EC2.Model.ReportInstanceStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReportInstanceStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the ReportInstanceStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RequestSpotFleet(Amazon.EC2.Model.RequestSpotFleetRequest)"> <summary> Creates a Spot fleet request. <para> You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet. </para> <para> By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload. </para> <para> Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html">Spot Fleet Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RequestSpotFleet service method.</param> <returns>The response from the RequestSpotFleet service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RequestSpotFleetAsync(Amazon.EC2.Model.RequestSpotFleetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RequestSpotFleet operation. </summary> <param name="request">Container for the necessary parameters to execute the RequestSpotFleet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RequestSpotInstances(Amazon.EC2.Model.RequestSpotInstancesRequest)"> <summary> Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the RequestSpotInstances service method.</param> <returns>The response from the RequestSpotInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RequestSpotInstancesAsync(Amazon.EC2.Model.RequestSpotInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RequestSpotInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the RequestSpotInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ResetImageAttribute(Amazon.EC2.Model.ResetImageAttributeRequest)"> <summary> Resets an attribute of an AMI to its default value. <note> <para> The productCodes attribute can't be reset. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ResetImageAttribute service method.</param> <returns>The response from the ResetImageAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ResetImageAttributeAsync(Amazon.EC2.Model.ResetImageAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetImageAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetImageAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ResetInstanceAttribute(Amazon.EC2.Model.ResetInstanceAttributeRequest)"> <summary> Resets an attribute of an instance to its default value. To reset the <code>kernel</code> or <code>ramdisk</code>, the instance must be in a stopped state. To reset the <code>SourceDestCheck</code>, the instance can be either running or stopped. <para> The <code>SourceDestCheck</code> attribute controls whether source/destination checking is enabled. The default value is <code>true</code>, which means checking is enabled. This value must be <code>false</code> for a NAT instance to perform NAT. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html">NAT Instances</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ResetInstanceAttribute service method.</param> <returns>The response from the ResetInstanceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ResetInstanceAttributeAsync(Amazon.EC2.Model.ResetInstanceAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetInstanceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetInstanceAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ResetNetworkInterfaceAttribute(Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest)"> <summary> Resets a network interface attribute. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the ResetNetworkInterfaceAttribute service method.</param> <returns>The response from the ResetNetworkInterfaceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ResetNetworkInterfaceAttributeAsync(Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetNetworkInterfaceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetNetworkInterfaceAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ResetSnapshotAttribute(Amazon.EC2.Model.ResetSnapshotAttributeRequest)"> <summary> Resets permission settings for the specified snapshot. <para> For more information on modifying snapshot permissions, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html">Sharing Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ResetSnapshotAttribute service method.</param> <returns>The response from the ResetSnapshotAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ResetSnapshotAttributeAsync(Amazon.EC2.Model.ResetSnapshotAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetSnapshotAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetSnapshotAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RestoreAddressToClassic(Amazon.EC2.Model.RestoreAddressToClassicRequest)"> <summary> Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface. </summary> <param name="request">Container for the necessary parameters to execute the RestoreAddressToClassic service method.</param> <returns>The response from the RestoreAddressToClassic service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RestoreAddressToClassicAsync(Amazon.EC2.Model.RestoreAddressToClassicRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestoreAddressToClassic operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreAddressToClassic operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RevokeSecurityGroupEgress(Amazon.EC2.Model.RevokeSecurityGroupEgressRequest)"> <summary> Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked. <para> Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. </para> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> </summary> <param name="request">Container for the necessary parameters to execute the RevokeSecurityGroupEgress service method.</param> <returns>The response from the RevokeSecurityGroupEgress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RevokeSecurityGroupEgressAsync(Amazon.EC2.Model.RevokeSecurityGroupEgressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RevokeSecurityGroupEgress operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeSecurityGroupEgress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RevokeSecurityGroupIngress(Amazon.EC2.Model.RevokeSecurityGroupIngressRequest)"> <summary> Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed. <para> Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. </para> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> </summary> <param name="request">Container for the necessary parameters to execute the RevokeSecurityGroupIngress service method.</param> <returns>The response from the RevokeSecurityGroupIngress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RevokeSecurityGroupIngressAsync(Amazon.EC2.Model.RevokeSecurityGroupIngressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RevokeSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeSecurityGroupIngress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RunInstances(Amazon.EC2.Model.RunInstancesRequest)"> <summary> Launches the specified number of instances using an AMI for which you have permissions. <para> When you launch an instance, it enters the <code>pending</code> state. After the instance is ready for you, it enters the <code>running</code> state. To check the state of your instance, call <a>DescribeInstances</a>. </para> <para> If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> [EC2-VPC only accounts] If you don't specify a subnet in the request, we choose a default subnet from your default VPC for you. </para> <para> [EC2-Classic accounts] If you're launching into EC2-Classic and you don't specify an Availability Zone, we choose one for you. </para> <para> Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> You can provide optional user data when launching an instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html">Instance Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> If any of the AMIs have a product code attached for which the user has not subscribed, <code>RunInstances</code> fails. </para> <para> T2 instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, <code>RunInstances</code> fails. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_InstanceStraightToTerminated.html">What To Do If An Instance Immediately Terminates</a>, and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.html">Troubleshooting Connecting to Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RunInstances service method.</param> <returns>The response from the RunInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RunInstancesAsync(Amazon.EC2.Model.RunInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RunInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the RunInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.StartInstances(Amazon.EC2.Model.StartInstancesRequest)"> <summary> Starts an Amazon EBS-backed AMI that you've previously stopped. <para> Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour. </para> <para> Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. </para> <para> Performing this operation on an instance that uses an instance store as its root device returns an error. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html">Stopping Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StartInstances service method.</param> <returns>The response from the StartInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.StartInstancesAsync(Amazon.EC2.Model.StartInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the StartInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.StopInstances(Amazon.EC2.Model.StopInstancesRequest)"> <summary> Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour. <para> You can't start or stop Spot Instances. </para> <para> Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. </para> <para> Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. </para> <para> Performing this operation on an instance that uses an instance store as its root device returns an error. </para> <para> You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesStopping.html">Troubleshooting Stopping Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StopInstances service method.</param> <returns>The response from the StopInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.StopInstancesAsync(Amazon.EC2.Model.StopInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StopInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the StopInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.TerminateInstances(Amazon.EC2.Model.TerminateInstancesRequest)"> <summary> Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. <para> Terminated instances remain visible after termination (for approximately one hour). </para> <para> By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running. </para> <para> You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the <code>DeleteOnTermination</code> block device mapping parameter set to <code>true</code> are automatically deleted. For more information about the differences between stopping and terminating instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesShuttingDown.html">Troubleshooting Terminating Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the TerminateInstances service method.</param> <returns>The response from the TerminateInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.TerminateInstancesAsync(Amazon.EC2.Model.TerminateInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TerminateInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the TerminateInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.UnassignPrivateIpAddresses(Amazon.EC2.Model.UnassignPrivateIpAddressesRequest)"> <summary> Unassigns one or more secondary private IP addresses from a network interface. </summary> <param name="request">Container for the necessary parameters to execute the UnassignPrivateIpAddresses service method.</param> <returns>The response from the UnassignPrivateIpAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.UnassignPrivateIpAddressesAsync(Amazon.EC2.Model.UnassignPrivateIpAddressesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UnassignPrivateIpAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the UnassignPrivateIpAddresses operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.UnmonitorInstances(Amazon.EC2.Model.UnmonitorInstancesRequest)"> <summary> Disables monitoring for a running instance. For more information about monitoring instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitoring Your Instances and Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the UnmonitorInstances service method.</param> <returns>The response from the UnmonitorInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.UnmonitorInstancesAsync(Amazon.EC2.Model.UnmonitorInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UnmonitorInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the UnmonitorInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DryRun(Amazon.EC2.AmazonEC2Request)"> <summary> Checks whether you have the required permissions for the action, without actually making the request. </summary> <param name="request">Request to do a dry run of.</param> <returns>Result of the dry run.</returns> </member> <member name="T:Amazon.ECS.AmazonECSClient"> <summary> Implementation for accessing ECS Amazon EC2 Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles. <para> You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure. </para> </summary> </member> <member name="T:Amazon.ECS.IAmazonECS"> <summary> Interface for accessing ECS Amazon EC2 Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles. <para> You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure. </para> </summary> </member> <member name="M:Amazon.ECS.IAmazonECS.CreateCluster(Amazon.ECS.Model.CreateClusterRequest)"> <summary> Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the <code>CreateCluster</code> action. </summary> <param name="request">Container for the necessary parameters to execute the CreateCluster service method.</param> <returns>The response from the CreateCluster service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.CreateClusterAsync(Amazon.ECS.Model.CreateClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.CreateService(Amazon.ECS.Model.CreateServiceRequest)"> <summary> Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below <code>desiredCount</code>, Amazon ECS spawns another instantiation of the task in the specified cluster. To update an existing service, see <a>UpdateService</a>. <para> You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition of a service with an <a>UpdateService</a> operation), the service scheduler uses the <code>minimumHealthyPercent</code> and <code>maximumPercent</code> parameters to determine the deployment strategy. </para> <para> If the <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore the <code>desiredCount</code> temporarily during a deployment. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>minimumHealthyPercent</code> of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state; tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance it is hosted on is reported as healthy by the load balancer. The default value for <code>minimumHealthyPercent</code> is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs. </para> <para> The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>maximumPercent</code> value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for <code>maximumPercent</code> is 200%. </para> <para> When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic: </para> <ul> <li> <para> Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes). </para> </li> <li> <para> Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. </para> </li> <li> <para> Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the CreateService service method.</param> <returns>The response from the CreateService service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.CreateServiceAsync(Amazon.ECS.Model.CreateServiceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateService operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateService operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DeleteCluster(Amazon.ECS.Model.DeleteClusterRequest)"> <summary> Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with <a>ListContainerInstances</a> and deregister them with <a>DeregisterContainerInstance</a>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCluster service method.</param> <returns>The response from the DeleteCluster service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterContainsContainerInstancesException"> You cannot delete a cluster that has registered container instances. You must first deregister the container instances before you can delete the cluster. For more information, see <a>DeregisterContainerInstance</a>. </exception> <exception cref="T:Amazon.ECS.Model.ClusterContainsServicesException"> You cannot delete a cluster that contains services. You must first update the service to reduce its desired task count to 0 and then delete the service. For more information, see <a>UpdateService</a> and <a>DeleteService</a>. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.DeleteClusterAsync(Amazon.ECS.Model.DeleteClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DeleteService(Amazon.ECS.Model.DeleteServiceRequest)"> <summary> Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see <a>UpdateService</a>. <note> <para> When you delete a service, if there are still running tasks that require cleanup, the service status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the service is no longer visible in the console or in <a>ListServices</a> API operations. After the tasks have stopped, then the service status moves from <code>DRAINING</code> to <code>INACTIVE</code>. Services in the <code>DRAINING</code> or <code>INACTIVE</code> status can still be viewed with <a>DescribeServices</a> API operations; however, in the future, <code>INACTIVE</code> services may be cleaned up and purged from Amazon ECS record keeping, and <a>DescribeServices</a> API operations on those services will return a <code>ServiceNotFoundException</code> error. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteService service method.</param> <returns>The response from the DeleteService service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> <exception cref="T:Amazon.ECS.Model.ServiceNotFoundException"> The specified service could not be found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster-specific and region-specific. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.DeleteServiceAsync(Amazon.ECS.Model.DeleteServiceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteService operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteService operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DeregisterContainerInstance(Amazon.ECS.Model.DeregisterContainerInstanceRequest)"> <summary> Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks. <para> If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources. </para> <para> Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing. </para> <note> <para> When you terminate a container instance, it is automatically deregistered from your cluster. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterContainerInstance service method.</param> <returns>The response from the DeregisterContainerInstance service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.DeregisterContainerInstanceAsync(Amazon.ECS.Model.DeregisterContainerInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterContainerInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterContainerInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DeregisterTaskDefinition(Amazon.ECS.Model.DeregisterTaskDefinitionRequest)"> <summary> Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as <code>INACTIVE</code>. Existing tasks and services that reference an <code>INACTIVE</code> task definition continue to run without disruption. Existing services that reference an <code>INACTIVE</code> task definition can still scale up or down by modifying the service's desired count. <para> You cannot use an <code>INACTIVE</code> task definition to run new tasks or create new services, and you cannot update an existing service to reference an <code>INACTIVE</code> task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect). </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterTaskDefinition service method.</param> <returns>The response from the DeregisterTaskDefinition service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.DeregisterTaskDefinitionAsync(Amazon.ECS.Model.DeregisterTaskDefinitionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterTaskDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterTaskDefinition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DescribeClusters(Amazon.ECS.Model.DescribeClustersRequest)"> <summary> Describes one or more of your clusters. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusters service method.</param> <returns>The response from the DescribeClusters service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.DescribeClustersAsync(Amazon.ECS.Model.DescribeClustersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DescribeContainerInstances(Amazon.ECS.Model.DescribeContainerInstancesRequest)"> <summary> Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested. </summary> <param name="request">Container for the necessary parameters to execute the DescribeContainerInstances service method.</param> <returns>The response from the DescribeContainerInstances service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.DescribeContainerInstancesAsync(Amazon.ECS.Model.DescribeContainerInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeContainerInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeContainerInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DescribeServices(Amazon.ECS.Model.DescribeServicesRequest)"> <summary> Describes the specified services running in your cluster. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServices service method.</param> <returns>The response from the DescribeServices service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.DescribeServicesAsync(Amazon.ECS.Model.DescribeServicesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeServices operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServices operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DescribeTaskDefinition(Amazon.ECS.Model.DescribeTaskDefinitionRequest)"> <summary> Describes a task definition. You can specify a <code>family</code> and <code>revision</code> to find information about a specific task definition, or you can simply specify the family to find the latest <code>ACTIVE</code> revision in that family. <note> <para> You can only describe <code>INACTIVE</code> task definitions while an active task or service references them. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTaskDefinition service method.</param> <returns>The response from the DescribeTaskDefinition service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.DescribeTaskDefinitionAsync(Amazon.ECS.Model.DescribeTaskDefinitionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTaskDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTaskDefinition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DescribeTasks(Amazon.ECS.Model.DescribeTasksRequest)"> <summary> Describes a specified task or tasks. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTasks service method.</param> <returns>The response from the DescribeTasks service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.DescribeTasksAsync(Amazon.ECS.Model.DescribeTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.ListClusters(Amazon.ECS.Model.ListClustersRequest)"> <summary> Returns a list of existing clusters. </summary> <param name="request">Container for the necessary parameters to execute the ListClusters service method.</param> <returns>The response from the ListClusters service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.ListClustersAsync(Amazon.ECS.Model.ListClustersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the ListClusters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.ListContainerInstances(Amazon.ECS.Model.ListContainerInstancesRequest)"> <summary> Returns a list of container instances in a specified cluster. </summary> <param name="request">Container for the necessary parameters to execute the ListContainerInstances service method.</param> <returns>The response from the ListContainerInstances service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.ListContainerInstancesAsync(Amazon.ECS.Model.ListContainerInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListContainerInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ListContainerInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.ListServices(Amazon.ECS.Model.ListServicesRequest)"> <summary> Lists the services that are running in a specified cluster. </summary> <param name="request">Container for the necessary parameters to execute the ListServices service method.</param> <returns>The response from the ListServices service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.ListServicesAsync(Amazon.ECS.Model.ListServicesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListServices operation. </summary> <param name="request">Container for the necessary parameters to execute the ListServices operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.ListTaskDefinitionFamilies(Amazon.ECS.Model.ListTaskDefinitionFamiliesRequest)"> <summary> Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any <code>ACTIVE</code> task definitions). You can filter the results with the <code>familyPrefix</code> parameter. </summary> <param name="request">Container for the necessary parameters to execute the ListTaskDefinitionFamilies service method.</param> <returns>The response from the ListTaskDefinitionFamilies service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.ListTaskDefinitionFamiliesAsync(Amazon.ECS.Model.ListTaskDefinitionFamiliesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTaskDefinitionFamilies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTaskDefinitionFamilies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.ListTaskDefinitions(Amazon.ECS.Model.ListTaskDefinitionsRequest)"> <summary> Returns a list of task definitions that are registered to your account. You can filter the results by family name with the <code>familyPrefix</code> parameter or by status with the <code>status</code> parameter. </summary> <param name="request">Container for the necessary parameters to execute the ListTaskDefinitions service method.</param> <returns>The response from the ListTaskDefinitions service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.ListTaskDefinitionsAsync(Amazon.ECS.Model.ListTaskDefinitionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTaskDefinitions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTaskDefinitions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.ListTasks(Amazon.ECS.Model.ListTasksRequest)"> <summary> Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the <code>family</code>, <code>containerInstance</code>, and <code>desiredStatus</code> parameters. </summary> <param name="request">Container for the necessary parameters to execute the ListTasks service method.</param> <returns>The response from the ListTasks service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> <exception cref="T:Amazon.ECS.Model.ServiceNotFoundException"> The specified service could not be found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster-specific and region-specific. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.ListTasksAsync(Amazon.ECS.Model.ListTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.RegisterTaskDefinition(Amazon.ECS.Model.RegisterTaskDefinitionRequest)"> <summary> Registers a new task definition from the supplied <code>family</code> and <code>containerDefinitions</code>. Optionally, you can add data volumes to your containers with the <code>volumes</code> parameter. For more information about task definition parameters and defaults, see <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Amazon ECS Task Definitions</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the RegisterTaskDefinition service method.</param> <returns>The response from the RegisterTaskDefinition service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.RegisterTaskDefinitionAsync(Amazon.ECS.Model.RegisterTaskDefinitionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterTaskDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterTaskDefinition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.RunTask(Amazon.ECS.Model.RunTaskRequest)"> <summary> Start a task using random placement and the default Amazon ECS scheduler. To use your own scheduler or place a task on a specific container instance, use <code>StartTask</code> instead. <important> <para> The <code>count</code> parameter is limited to 10 tasks per call. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the RunTask service method.</param> <returns>The response from the RunTask service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.RunTaskAsync(Amazon.ECS.Model.RunTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RunTask operation. </summary> <param name="request">Container for the necessary parameters to execute the RunTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.StartTask(Amazon.ECS.Model.StartTaskRequest)"> <summary> Starts a new task from the specified task definition on the specified container instance or instances. To use the default Amazon ECS scheduler to place your task, use <code>RunTask</code> instead. <important> <para> The list of container instances to start tasks on is limited to 10. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the StartTask service method.</param> <returns>The response from the StartTask service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.StartTaskAsync(Amazon.ECS.Model.StartTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartTask operation. </summary> <param name="request">Container for the necessary parameters to execute the StartTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.StopTask(Amazon.ECS.Model.StopTaskRequest)"> <summary> Stops a running task. <para> When <a>StopTask</a> is called on a task, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout, after which <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent. </para> </summary> <param name="request">Container for the necessary parameters to execute the StopTask service method.</param> <returns>The response from the StopTask service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.StopTaskAsync(Amazon.ECS.Model.StopTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StopTask operation. </summary> <param name="request">Container for the necessary parameters to execute the StopTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.UpdateContainerAgent(Amazon.ECS.Model.UpdateContainerAgentRequest)"> <summary> Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system. <para> <code>UpdateContainerAgent</code> requires the Amazon ECS-optimized AMI or Amazon Linux with the <code>ecs-init</code> service installed and running. For help updating the Amazon ECS container agent on other operating systems, see <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually Updating the Amazon ECS Container Agent</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateContainerAgent service method.</param> <returns>The response from the UpdateContainerAgent service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.MissingVersionException"> Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information. </exception> <exception cref="T:Amazon.ECS.Model.NoUpdateAvailableException"> There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> <exception cref="T:Amazon.ECS.Model.UpdateInProgressException"> There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.UpdateContainerAgentAsync(Amazon.ECS.Model.UpdateContainerAgentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateContainerAgent operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateContainerAgent operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.UpdateService(Amazon.ECS.Model.UpdateServiceRequest)"> <summary> Modifies the desired count, deployment configuration, or task definition used in a service. <para> You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new <code>desiredCount</code> parameter. </para> <para> You can use <a>UpdateService</a> to modify your task definition and deploy a new version of your service. </para> <para> You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>, to determine the deployment strategy. </para> <para> If the <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore the <code>desiredCount</code> temporarily during a deployment. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>minimumHealthyPercent</code> of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state; tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance it is hosted on is reported as healthy by the load balancer. </para> <para> The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>maximumPercent</code> value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). </para> <para> When <a>UpdateService</a> stops a task during a deployment, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout, after which <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent. </para> <para> When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic: </para> <ul> <li> <para> Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes). </para> </li> <li> <para> Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. </para> </li> <li> <para> Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the UpdateService service method.</param> <returns>The response from the UpdateService service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> <exception cref="T:Amazon.ECS.Model.ServiceNotActiveException"> The specified service is not active. You cannot update a service that is not active. If you have previously deleted a service, you can re-create it with <a>CreateService</a>. </exception> <exception cref="T:Amazon.ECS.Model.ServiceNotFoundException"> The specified service could not be found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster-specific and region-specific. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.UpdateServiceAsync(Amazon.ECS.Model.UpdateServiceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateService operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateService operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor"> <summary> Constructs AmazonECSClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonECSClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(Amazon.ECS.AmazonECSConfig)"> <summary> Constructs AmazonECSClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonECSClient Configuration Object</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonECSClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonECSClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.ECS.AmazonECSConfig)"> <summary> Constructs AmazonECSClient with AWS Credentials and an AmazonECSClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonECSClient Configuration Object</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonECSClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonECSClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(System.String,System.String,Amazon.ECS.AmazonECSConfig)"> <summary> Constructs AmazonECSClient with AWS Access Key ID, AWS Secret Key and an AmazonECSClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonECSClient Configuration Object</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonECSClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonECSClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(System.String,System.String,System.String,Amazon.ECS.AmazonECSConfig)"> <summary> Constructs AmazonECSClient with AWS Access Key ID, AWS Secret Key and an AmazonECSClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonECSClient Configuration Object</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.CreateCluster(Amazon.ECS.Model.CreateClusterRequest)"> <summary> Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the <code>CreateCluster</code> action. </summary> <param name="request">Container for the necessary parameters to execute the CreateCluster service method.</param> <returns>The response from the CreateCluster service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.CreateClusterAsync(Amazon.ECS.Model.CreateClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.CreateService(Amazon.ECS.Model.CreateServiceRequest)"> <summary> Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below <code>desiredCount</code>, Amazon ECS spawns another instantiation of the task in the specified cluster. To update an existing service, see <a>UpdateService</a>. <para> You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition of a service with an <a>UpdateService</a> operation), the service scheduler uses the <code>minimumHealthyPercent</code> and <code>maximumPercent</code> parameters to determine the deployment strategy. </para> <para> If the <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore the <code>desiredCount</code> temporarily during a deployment. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>minimumHealthyPercent</code> of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state; tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance it is hosted on is reported as healthy by the load balancer. The default value for <code>minimumHealthyPercent</code> is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs. </para> <para> The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>maximumPercent</code> value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for <code>maximumPercent</code> is 200%. </para> <para> When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic: </para> <ul> <li> <para> Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes). </para> </li> <li> <para> Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. </para> </li> <li> <para> Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the CreateService service method.</param> <returns>The response from the CreateService service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.CreateServiceAsync(Amazon.ECS.Model.CreateServiceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateService operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateService operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DeleteCluster(Amazon.ECS.Model.DeleteClusterRequest)"> <summary> Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with <a>ListContainerInstances</a> and deregister them with <a>DeregisterContainerInstance</a>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCluster service method.</param> <returns>The response from the DeleteCluster service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterContainsContainerInstancesException"> You cannot delete a cluster that has registered container instances. You must first deregister the container instances before you can delete the cluster. For more information, see <a>DeregisterContainerInstance</a>. </exception> <exception cref="T:Amazon.ECS.Model.ClusterContainsServicesException"> You cannot delete a cluster that contains services. You must first update the service to reduce its desired task count to 0 and then delete the service. For more information, see <a>UpdateService</a> and <a>DeleteService</a>. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.DeleteClusterAsync(Amazon.ECS.Model.DeleteClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DeleteService(Amazon.ECS.Model.DeleteServiceRequest)"> <summary> Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see <a>UpdateService</a>. <note> <para> When you delete a service, if there are still running tasks that require cleanup, the service status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the service is no longer visible in the console or in <a>ListServices</a> API operations. After the tasks have stopped, then the service status moves from <code>DRAINING</code> to <code>INACTIVE</code>. Services in the <code>DRAINING</code> or <code>INACTIVE</code> status can still be viewed with <a>DescribeServices</a> API operations; however, in the future, <code>INACTIVE</code> services may be cleaned up and purged from Amazon ECS record keeping, and <a>DescribeServices</a> API operations on those services will return a <code>ServiceNotFoundException</code> error. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteService service method.</param> <returns>The response from the DeleteService service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> <exception cref="T:Amazon.ECS.Model.ServiceNotFoundException"> The specified service could not be found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster-specific and region-specific. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.DeleteServiceAsync(Amazon.ECS.Model.DeleteServiceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteService operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteService operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DeregisterContainerInstance(Amazon.ECS.Model.DeregisterContainerInstanceRequest)"> <summary> Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks. <para> If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources. </para> <para> Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing. </para> <note> <para> When you terminate a container instance, it is automatically deregistered from your cluster. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterContainerInstance service method.</param> <returns>The response from the DeregisterContainerInstance service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.DeregisterContainerInstanceAsync(Amazon.ECS.Model.DeregisterContainerInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterContainerInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterContainerInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DeregisterTaskDefinition(Amazon.ECS.Model.DeregisterTaskDefinitionRequest)"> <summary> Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as <code>INACTIVE</code>. Existing tasks and services that reference an <code>INACTIVE</code> task definition continue to run without disruption. Existing services that reference an <code>INACTIVE</code> task definition can still scale up or down by modifying the service's desired count. <para> You cannot use an <code>INACTIVE</code> task definition to run new tasks or create new services, and you cannot update an existing service to reference an <code>INACTIVE</code> task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect). </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterTaskDefinition service method.</param> <returns>The response from the DeregisterTaskDefinition service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.DeregisterTaskDefinitionAsync(Amazon.ECS.Model.DeregisterTaskDefinitionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterTaskDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterTaskDefinition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DescribeClusters(Amazon.ECS.Model.DescribeClustersRequest)"> <summary> Describes one or more of your clusters. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusters service method.</param> <returns>The response from the DescribeClusters service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.DescribeClustersAsync(Amazon.ECS.Model.DescribeClustersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DescribeContainerInstances(Amazon.ECS.Model.DescribeContainerInstancesRequest)"> <summary> Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested. </summary> <param name="request">Container for the necessary parameters to execute the DescribeContainerInstances service method.</param> <returns>The response from the DescribeContainerInstances service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.DescribeContainerInstancesAsync(Amazon.ECS.Model.DescribeContainerInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeContainerInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeContainerInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DescribeServices(Amazon.ECS.Model.DescribeServicesRequest)"> <summary> Describes the specified services running in your cluster. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServices service method.</param> <returns>The response from the DescribeServices service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.DescribeServicesAsync(Amazon.ECS.Model.DescribeServicesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeServices operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServices operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DescribeTaskDefinition(Amazon.ECS.Model.DescribeTaskDefinitionRequest)"> <summary> Describes a task definition. You can specify a <code>family</code> and <code>revision</code> to find information about a specific task definition, or you can simply specify the family to find the latest <code>ACTIVE</code> revision in that family. <note> <para> You can only describe <code>INACTIVE</code> task definitions while an active task or service references them. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTaskDefinition service method.</param> <returns>The response from the DescribeTaskDefinition service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.DescribeTaskDefinitionAsync(Amazon.ECS.Model.DescribeTaskDefinitionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTaskDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTaskDefinition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DescribeTasks(Amazon.ECS.Model.DescribeTasksRequest)"> <summary> Describes a specified task or tasks. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTasks service method.</param> <returns>The response from the DescribeTasks service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.DescribeTasksAsync(Amazon.ECS.Model.DescribeTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListClusters(Amazon.ECS.Model.ListClustersRequest)"> <summary> Returns a list of existing clusters. </summary> <param name="request">Container for the necessary parameters to execute the ListClusters service method.</param> <returns>The response from the ListClusters service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListClustersAsync(Amazon.ECS.Model.ListClustersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the ListClusters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListContainerInstances(Amazon.ECS.Model.ListContainerInstancesRequest)"> <summary> Returns a list of container instances in a specified cluster. </summary> <param name="request">Container for the necessary parameters to execute the ListContainerInstances service method.</param> <returns>The response from the ListContainerInstances service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListContainerInstancesAsync(Amazon.ECS.Model.ListContainerInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListContainerInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ListContainerInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListServices(Amazon.ECS.Model.ListServicesRequest)"> <summary> Lists the services that are running in a specified cluster. </summary> <param name="request">Container for the necessary parameters to execute the ListServices service method.</param> <returns>The response from the ListServices service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListServicesAsync(Amazon.ECS.Model.ListServicesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListServices operation. </summary> <param name="request">Container for the necessary parameters to execute the ListServices operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListTaskDefinitionFamilies(Amazon.ECS.Model.ListTaskDefinitionFamiliesRequest)"> <summary> Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any <code>ACTIVE</code> task definitions). You can filter the results with the <code>familyPrefix</code> parameter. </summary> <param name="request">Container for the necessary parameters to execute the ListTaskDefinitionFamilies service method.</param> <returns>The response from the ListTaskDefinitionFamilies service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListTaskDefinitionFamiliesAsync(Amazon.ECS.Model.ListTaskDefinitionFamiliesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTaskDefinitionFamilies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTaskDefinitionFamilies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListTaskDefinitions(Amazon.ECS.Model.ListTaskDefinitionsRequest)"> <summary> Returns a list of task definitions that are registered to your account. You can filter the results by family name with the <code>familyPrefix</code> parameter or by status with the <code>status</code> parameter. </summary> <param name="request">Container for the necessary parameters to execute the ListTaskDefinitions service method.</param> <returns>The response from the ListTaskDefinitions service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListTaskDefinitionsAsync(Amazon.ECS.Model.ListTaskDefinitionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTaskDefinitions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTaskDefinitions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListTasks(Amazon.ECS.Model.ListTasksRequest)"> <summary> Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the <code>family</code>, <code>containerInstance</code>, and <code>desiredStatus</code> parameters. </summary> <param name="request">Container for the necessary parameters to execute the ListTasks service method.</param> <returns>The response from the ListTasks service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> <exception cref="T:Amazon.ECS.Model.ServiceNotFoundException"> The specified service could not be found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster-specific and region-specific. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListTasksAsync(Amazon.ECS.Model.ListTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.RegisterTaskDefinition(Amazon.ECS.Model.RegisterTaskDefinitionRequest)"> <summary> Registers a new task definition from the supplied <code>family</code> and <code>containerDefinitions</code>. Optionally, you can add data volumes to your containers with the <code>volumes</code> parameter. For more information about task definition parameters and defaults, see <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Amazon ECS Task Definitions</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the RegisterTaskDefinition service method.</param> <returns>The response from the RegisterTaskDefinition service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.RegisterTaskDefinitionAsync(Amazon.ECS.Model.RegisterTaskDefinitionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterTaskDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterTaskDefinition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.RunTask(Amazon.ECS.Model.RunTaskRequest)"> <summary> Start a task using random placement and the default Amazon ECS scheduler. To use your own scheduler or place a task on a specific container instance, use <code>StartTask</code> instead. <important> <para> The <code>count</code> parameter is limited to 10 tasks per call. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the RunTask service method.</param> <returns>The response from the RunTask service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.RunTaskAsync(Amazon.ECS.Model.RunTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RunTask operation. </summary> <param name="request">Container for the necessary parameters to execute the RunTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.StartTask(Amazon.ECS.Model.StartTaskRequest)"> <summary> Starts a new task from the specified task definition on the specified container instance or instances. To use the default Amazon ECS scheduler to place your task, use <code>RunTask</code> instead. <important> <para> The list of container instances to start tasks on is limited to 10. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the StartTask service method.</param> <returns>The response from the StartTask service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.StartTaskAsync(Amazon.ECS.Model.StartTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartTask operation. </summary> <param name="request">Container for the necessary parameters to execute the StartTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.StopTask(Amazon.ECS.Model.StopTaskRequest)"> <summary> Stops a running task. <para> When <a>StopTask</a> is called on a task, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout, after which <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent. </para> </summary> <param name="request">Container for the necessary parameters to execute the StopTask service method.</param> <returns>The response from the StopTask service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.StopTaskAsync(Amazon.ECS.Model.StopTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StopTask operation. </summary> <param name="request">Container for the necessary parameters to execute the StopTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.UpdateContainerAgent(Amazon.ECS.Model.UpdateContainerAgentRequest)"> <summary> Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system. <para> <code>UpdateContainerAgent</code> requires the Amazon ECS-optimized AMI or Amazon Linux with the <code>ecs-init</code> service installed and running. For help updating the Amazon ECS container agent on other operating systems, see <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually Updating the Amazon ECS Container Agent</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateContainerAgent service method.</param> <returns>The response from the UpdateContainerAgent service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.MissingVersionException"> Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information. </exception> <exception cref="T:Amazon.ECS.Model.NoUpdateAvailableException"> There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> <exception cref="T:Amazon.ECS.Model.UpdateInProgressException"> There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.UpdateContainerAgentAsync(Amazon.ECS.Model.UpdateContainerAgentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateContainerAgent operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateContainerAgent operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.UpdateService(Amazon.ECS.Model.UpdateServiceRequest)"> <summary> Modifies the desired count, deployment configuration, or task definition used in a service. <para> You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new <code>desiredCount</code> parameter. </para> <para> You can use <a>UpdateService</a> to modify your task definition and deploy a new version of your service. </para> <para> You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>, to determine the deployment strategy. </para> <para> If the <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore the <code>desiredCount</code> temporarily during a deployment. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>minimumHealthyPercent</code> of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state; tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance it is hosted on is reported as healthy by the load balancer. </para> <para> The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>maximumPercent</code> value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). </para> <para> When <a>UpdateService</a> stops a task during a deployment, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout, after which <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent. </para> <para> When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic: </para> <ul> <li> <para> Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes). </para> </li> <li> <para> Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. </para> </li> <li> <para> Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the UpdateService service method.</param> <returns>The response from the UpdateService service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> <exception cref="T:Amazon.ECS.Model.ServiceNotActiveException"> The specified service is not active. You cannot update a service that is not active. If you have previously deleted a service, you can re-create it with <a>CreateService</a>. </exception> <exception cref="T:Amazon.ECS.Model.ServiceNotFoundException"> The specified service could not be found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster-specific and region-specific. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.UpdateServiceAsync(Amazon.ECS.Model.UpdateServiceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateService operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateService operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.ElastiCache.AmazonElastiCacheClient"> <summary> Implementation for accessing ElastiCache Amazon ElastiCache <para> Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud. </para> <para> With ElastiCache, customers gain all of the benefits of a high-performance, in-memory cache with far less of the administrative burden of launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment. </para> <para> In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot. </para> </summary> </member> <member name="T:Amazon.ElastiCache.IAmazonElastiCache"> <summary> Interface for accessing ElastiCache Amazon ElastiCache <para> Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud. </para> <para> With ElastiCache, customers gain all of the benefits of a high-performance, in-memory cache with far less of the administrative burden of launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment. </para> <para> In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot. </para> </summary> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.AddTagsToResource(Amazon.ElastiCache.Model.AddTagsToResourceRequest)"> <summary> The <i>AddTagsToResource</i> action adds up to 10 cost allocation tags to the named resource. A <i>cost allocation tag</i> is a key-value pair where the key and value are case-sensitive. Cost allocation tags can be used to categorize and track your AWS costs. <para> When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Tagging.html">Using Cost Allocation Tags in Amazon ElastiCache</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToResource service method.</param> <returns>The response from the AddTagsToResource service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidARNException"> The requested Amazon Resource Name (ARN) does not refer to an existing resource. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"> The requested snapshot name does not refer to an existing snapshot. </exception> <exception cref="T:Amazon.ElastiCache.Model.TagQuotaPerResourceExceededException"> The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 10. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.AddTagsToResourceAsync(Amazon.ElastiCache.Model.AddTagsToResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTagsToResource operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.AuthorizeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest)"> <summary> The <i>AuthorizeCacheSecurityGroupIngress</i> action allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism. <note>You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region. </note> </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeCacheSecurityGroupIngress service method.</param> <returns>The response from the AuthorizeCacheSecurityGroupIngress service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.AuthorizationAlreadyExistsException"> The specified Amazon EC2 security group is already authorized for the specified cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"> The current state of the cache security group does not allow deletion. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.AuthorizeCacheSecurityGroupIngressAsync(Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AuthorizeCacheSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeCacheSecurityGroupIngress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.CopySnapshot(Amazon.ElastiCache.Model.CopySnapshotRequest)"> <summary> The <i>CopySnapshot</i> action makes a copy of an existing snapshot. </summary> <param name="request">Container for the necessary parameters to execute the CopySnapshot service method.</param> <returns>The response from the CopySnapshot service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidSnapshotStateException"> The current state of the snapshot does not allow the requested action to occur. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"> You already have a snapshot with the given name. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"> The requested snapshot name does not refer to an existing snapshot. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"> The request cannot be processed because it would exceed the maximum number of snapshots. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.CopySnapshotAsync(Amazon.ElastiCache.Model.CopySnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopySnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CopySnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.CreateCacheCluster(Amazon.ElastiCache.Model.CreateCacheClusterRequest)"> <summary> The <i>CreateCacheCluster</i> action creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis. </summary> <param name="request">Container for the necessary parameters to execute the CreateCacheCluster service method.</param> <returns>The response from the CreateCacheCluster service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterAlreadyExistsException"> You already have a cache cluster with the given identifier. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"> The requested cache subnet group name does not refer to an existing cache subnet group. </exception> <exception cref="T:Amazon.ElastiCache.Model.ClusterQuotaForCustomerExceededException"> The request cannot be processed because it would exceed the allowed number of cache clusters per customer. </exception> <exception cref="T:Amazon.ElastiCache.Model.InsufficientCacheClusterCapacityException"> The requested cache node type is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidReplicationGroupStateException"> The requested replication group is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidVPCNetworkStateException"> The VPC network is in an invalid state. </exception> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForClusterExceededException"> The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForCustomerExceededException"> The request cannot be processed because it would exceed the allowed number of cache nodes per customer. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"> The specified replication group does not exist. </exception> <exception cref="T:Amazon.ElastiCache.Model.TagQuotaPerResourceExceededException"> The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 10. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.CreateCacheClusterAsync(Amazon.ElastiCache.Model.CreateCacheClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCacheCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCacheCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.CreateCacheParameterGroup(Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest)"> <summary> The <i>CreateCacheParameterGroup</i> action creates a new cache parameter group. A cache parameter group is a collection of parameters that you apply to all of the nodes in a cache cluster. </summary> <param name="request">Container for the necessary parameters to execute the CreateCacheParameterGroup service method.</param> <returns>The response from the CreateCacheParameterGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupAlreadyExistsException"> A cache parameter group with the requested name already exists. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupQuotaExceededException"> The request cannot be processed because it would exceed the maximum number of cache security groups. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"> The current state of the cache parameter group does not allow the requested action to occur. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.CreateCacheParameterGroupAsync(Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCacheParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCacheParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.CreateCacheSecurityGroup(Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest)"> <summary> The <i>CreateCacheSecurityGroup</i> action creates a new cache security group. Use a cache security group to control access to one or more cache clusters. <para> Cache security groups are only used when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cache cluster inside of a VPC, use a cache subnet group instead. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html">CreateCacheSubnetGroup</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateCacheSecurityGroup service method.</param> <returns>The response from the CreateCacheSecurityGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupAlreadyExistsException"> A cache security group with the specified name already exists. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupQuotaExceededException"> The request cannot be processed because it would exceed the allowed number of cache security groups. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.CreateCacheSecurityGroupAsync(Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCacheSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCacheSecurityGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.CreateCacheSubnetGroup(Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest)"> <summary> The <i>CreateCacheSubnetGroup</i> action creates a new cache subnet group. <para> Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC). </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateCacheSubnetGroup service method.</param> <returns>The response from the CreateCacheSubnetGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupAlreadyExistsException"> The requested cache subnet group name is already in use by an existing cache subnet group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupQuotaExceededException"> The request cannot be processed because it would exceed the allowed number of cache subnet groups. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetQuotaExceededException"> The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidSubnetException"> An invalid subnet identifier was specified. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.CreateCacheSubnetGroupAsync(Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCacheSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCacheSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.CreateReplicationGroup(Amazon.ElastiCache.Model.CreateReplicationGroupRequest)"> <summary> The <i>CreateReplicationGroup</i> action creates a replication group. A replication group is a collection of cache clusters, where one of the cache clusters is a read/write primary and the others are read-only replicas. Writes to the primary are automatically propagated to the replicas. <para> When you create a replication group, you must specify an existing cache cluster that is in the primary role. When the replication group has been successfully created, you can add one or more read replica replicas to it, up to a total of five read replicas. </para> <para> <b>Note:</b> This action is valid only for Redis. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateReplicationGroup service method.</param> <returns>The response from the CreateReplicationGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"> The requested cache subnet group name does not refer to an existing cache subnet group. </exception> <exception cref="T:Amazon.ElastiCache.Model.ClusterQuotaForCustomerExceededException"> The request cannot be processed because it would exceed the allowed number of cache clusters per customer. </exception> <exception cref="T:Amazon.ElastiCache.Model.InsufficientCacheClusterCapacityException"> The requested cache node type is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"> The requested cache cluster is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidVPCNetworkStateException"> The VPC network is in an invalid state. </exception> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForClusterExceededException"> The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForCustomerExceededException"> The request cannot be processed because it would exceed the allowed number of cache nodes per customer. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupAlreadyExistsException"> The specified replication group already exists. </exception> <exception cref="T:Amazon.ElastiCache.Model.TagQuotaPerResourceExceededException"> The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 10. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.CreateReplicationGroupAsync(Amazon.ElastiCache.Model.CreateReplicationGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateReplicationGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateReplicationGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.CreateSnapshot(Amazon.ElastiCache.Model.CreateSnapshotRequest)"> <summary> The <i>CreateSnapshot</i> action creates a copy of an entire cache cluster at a specific moment in time. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot service method.</param> <returns>The response from the CreateSnapshot service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"> The requested cache cluster is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"> You already have a snapshot with the given name. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotFeatureNotSupportedException"> You attempted one of the following actions: <ul> <li> <para> Creating a snapshot of a Redis cache cluster running on a <i>t1.micro</i> cache node. </para> </li> <li> <para> Creating a snapshot of a cache cluster that is running Memcached rather than Redis. </para> </li> </ul> <para> Neither of these are supported by ElastiCache. </para> </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"> The request cannot be processed because it would exceed the maximum number of snapshots. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.CreateSnapshotAsync(Amazon.ElastiCache.Model.CreateSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DeleteCacheCluster(Amazon.ElastiCache.Model.DeleteCacheClusterRequest)"> <summary> The <i>DeleteCacheCluster</i> action deletes a previously provisioned cache cluster. <i>DeleteCacheCluster</i> deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this action. <para> This API cannot be used to delete a cache cluster that is the last read replica of a replication group that has Multi-AZ mode enabled. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteCacheCluster service method.</param> <returns>The response from the DeleteCacheCluster service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"> The requested cache cluster is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"> You already have a snapshot with the given name. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotFeatureNotSupportedException"> You attempted one of the following actions: <ul> <li> <para> Creating a snapshot of a Redis cache cluster running on a <i>t1.micro</i> cache node. </para> </li> <li> <para> Creating a snapshot of a cache cluster that is running Memcached rather than Redis. </para> </li> </ul> <para> Neither of these are supported by ElastiCache. </para> </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"> The request cannot be processed because it would exceed the maximum number of snapshots. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DeleteCacheClusterAsync(Amazon.ElastiCache.Model.DeleteCacheClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCacheCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCacheCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DeleteCacheParameterGroup(Amazon.ElastiCache.Model.DeleteCacheParameterGroupRequest)"> <summary> The <i>DeleteCacheParameterGroup</i> action deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCacheParameterGroup service method.</param> <returns>The response from the DeleteCacheParameterGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"> The current state of the cache parameter group does not allow the requested action to occur. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DeleteCacheParameterGroupAsync(Amazon.ElastiCache.Model.DeleteCacheParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCacheParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCacheParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DeleteCacheSecurityGroup(Amazon.ElastiCache.Model.DeleteCacheSecurityGroupRequest)"> <summary> The <i>DeleteCacheSecurityGroup</i> action deletes a cache security group. <note>You cannot delete a cache security group if it is associated with any cache clusters.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteCacheSecurityGroup service method.</param> <returns>The response from the DeleteCacheSecurityGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"> The current state of the cache security group does not allow deletion. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DeleteCacheSecurityGroupAsync(Amazon.ElastiCache.Model.DeleteCacheSecurityGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCacheSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCacheSecurityGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DeleteCacheSubnetGroup(Amazon.ElastiCache.Model.DeleteCacheSubnetGroupRequest)"> <summary> The <i>DeleteCacheSubnetGroup</i> action deletes a cache subnet group. <note>You cannot delete a cache subnet group if it is associated with any cache clusters.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteCacheSubnetGroup service method.</param> <returns>The response from the DeleteCacheSubnetGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupInUseException"> The requested cache subnet group is currently in use. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"> The requested cache subnet group name does not refer to an existing cache subnet group. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DeleteCacheSubnetGroupAsync(Amazon.ElastiCache.Model.DeleteCacheSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCacheSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCacheSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DeleteReplicationGroup(Amazon.ElastiCache.Model.DeleteReplicationGroupRequest)"> <summary> The <i>DeleteReplicationGroup</i> action deletes an existing replication group. By default, this action deletes the entire replication group, including the primary cluster and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary cluster. <para> When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteReplicationGroup service method.</param> <returns>The response from the DeleteReplicationGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidReplicationGroupStateException"> The requested replication group is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"> The specified replication group does not exist. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"> You already have a snapshot with the given name. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotFeatureNotSupportedException"> You attempted one of the following actions: <ul> <li> <para> Creating a snapshot of a Redis cache cluster running on a <i>t1.micro</i> cache node. </para> </li> <li> <para> Creating a snapshot of a cache cluster that is running Memcached rather than Redis. </para> </li> </ul> <para> Neither of these are supported by ElastiCache. </para> </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"> The request cannot be processed because it would exceed the maximum number of snapshots. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DeleteReplicationGroupAsync(Amazon.ElastiCache.Model.DeleteReplicationGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteReplicationGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteReplicationGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DeleteSnapshot(Amazon.ElastiCache.Model.DeleteSnapshotRequest)"> <summary> The <i>DeleteSnapshot</i> action deletes an existing snapshot. When you receive a successful response from this action, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this action. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot service method.</param> <returns>The response from the DeleteSnapshot service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidSnapshotStateException"> The current state of the snapshot does not allow the requested action to occur. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"> The requested snapshot name does not refer to an existing snapshot. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DeleteSnapshotAsync(Amazon.ElastiCache.Model.DeleteSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheClusters"> <summary> The <i>DescribeCacheClusters</i> action returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied. <para> By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional <i>ShowDetails</i> flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint. </para> <para> If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned. </para> <para> If the cluster is in the DELETING state, only cluster level information will be displayed. </para> <para> If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is <i>available</i>, the cluster is ready for use. </para> <para> If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed. </para> </summary> <returns>The response from the DescribeCacheClusters service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheClusters(Amazon.ElastiCache.Model.DescribeCacheClustersRequest)"> <summary> The <i>DescribeCacheClusters</i> action returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied. <para> By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional <i>ShowDetails</i> flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint. </para> <para> If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned. </para> <para> If the cluster is in the DELETING state, only cluster level information will be displayed. </para> <para> If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is <i>available</i>, the cluster is ready for use. </para> <para> If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheClusters service method.</param> <returns>The response from the DescribeCacheClusters service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheClustersAsync(Amazon.ElastiCache.Model.DescribeCacheClustersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCacheClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheClusters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheEngineVersions"> <summary> The <i>DescribeCacheEngineVersions</i> action returns a list of the available cache engines and their versions. </summary> <returns>The response from the DescribeCacheEngineVersions service method, as returned by ElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheEngineVersions(Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest)"> <summary> The <i>DescribeCacheEngineVersions</i> action returns a list of the available cache engines and their versions. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheEngineVersions service method.</param> <returns>The response from the DescribeCacheEngineVersions service method, as returned by ElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheEngineVersionsAsync(Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCacheEngineVersions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheEngineVersions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheParameterGroups"> <summary> The <i>DescribeCacheParameterGroups</i> action returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group. </summary> <returns>The response from the DescribeCacheParameterGroups service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheParameterGroups(Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest)"> <summary> The <i>DescribeCacheParameterGroups</i> action returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheParameterGroups service method.</param> <returns>The response from the DescribeCacheParameterGroups service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheParameterGroupsAsync(Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCacheParameterGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheParameterGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheParameters(Amazon.ElastiCache.Model.DescribeCacheParametersRequest)"> <summary> The <i>DescribeCacheParameters</i> action returns the detailed parameter list for a particular cache parameter group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheParameters service method.</param> <returns>The response from the DescribeCacheParameters service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheParametersAsync(Amazon.ElastiCache.Model.DescribeCacheParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCacheParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheSecurityGroups"> <summary> The <i>DescribeCacheSecurityGroups</i> action returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group. </summary> <returns>The response from the DescribeCacheSecurityGroups service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheSecurityGroups(Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest)"> <summary> The <i>DescribeCacheSecurityGroups</i> action returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheSecurityGroups service method.</param> <returns>The response from the DescribeCacheSecurityGroups service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheSecurityGroupsAsync(Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCacheSecurityGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheSecurityGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheSubnetGroups"> <summary> The <i>DescribeCacheSubnetGroups</i> action returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group. </summary> <returns>The response from the DescribeCacheSubnetGroups service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"> The requested cache subnet group name does not refer to an existing cache subnet group. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheSubnetGroups(Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest)"> <summary> The <i>DescribeCacheSubnetGroups</i> action returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheSubnetGroups service method.</param> <returns>The response from the DescribeCacheSubnetGroups service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"> The requested cache subnet group name does not refer to an existing cache subnet group. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheSubnetGroupsAsync(Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCacheSubnetGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheSubnetGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeEngineDefaultParameters(Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest)"> <summary> The <i>DescribeEngineDefaultParameters</i> action returns the default engine and system parameter information for the specified cache engine. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEngineDefaultParameters service method.</param> <returns>The response from the DescribeEngineDefaultParameters service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeEngineDefaultParametersAsync(Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEngineDefaultParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEngineDefaultParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeEvents"> <summary> The <i>DescribeEvents</i> action returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter. <para> By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary. </para> </summary> <returns>The response from the DescribeEvents service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeEvents(Amazon.ElastiCache.Model.DescribeEventsRequest)"> <summary> The <i>DescribeEvents</i> action returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter. <para> By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents service method.</param> <returns>The response from the DescribeEvents service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeEventsAsync(Amazon.ElastiCache.Model.DescribeEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeReplicationGroups"> <summary> The <i>DescribeReplicationGroups</i> action returns information about a particular replication group. If no identifier is specified, <i>DescribeReplicationGroups</i> returns information about all replication groups. </summary> <returns>The response from the DescribeReplicationGroups service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"> The specified replication group does not exist. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeReplicationGroups(Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest)"> <summary> The <i>DescribeReplicationGroups</i> action returns information about a particular replication group. If no identifier is specified, <i>DescribeReplicationGroups</i> returns information about all replication groups. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReplicationGroups service method.</param> <returns>The response from the DescribeReplicationGroups service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"> The specified replication group does not exist. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeReplicationGroupsAsync(Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReplicationGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReplicationGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeReservedCacheNodes"> <summary> The <i>DescribeReservedCacheNodes</i> action returns information about reserved cache nodes for this account, or about a specified reserved cache node. </summary> <returns>The response from the DescribeReservedCacheNodes service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodeNotFoundException"> The requested reserved cache node was not found. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeReservedCacheNodes(Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest)"> <summary> The <i>DescribeReservedCacheNodes</i> action returns information about reserved cache nodes for this account, or about a specified reserved cache node. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedCacheNodes service method.</param> <returns>The response from the DescribeReservedCacheNodes service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodeNotFoundException"> The requested reserved cache node was not found. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeReservedCacheNodesAsync(Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedCacheNodes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedCacheNodes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeReservedCacheNodesOfferings"> <summary> The <i>DescribeReservedCacheNodesOfferings</i> action lists available reserved cache node offerings. </summary> <returns>The response from the DescribeReservedCacheNodesOfferings service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodesOfferingNotFoundException"> The requested cache node offering does not exist. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeReservedCacheNodesOfferings(Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest)"> <summary> The <i>DescribeReservedCacheNodesOfferings</i> action lists available reserved cache node offerings. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedCacheNodesOfferings service method.</param> <returns>The response from the DescribeReservedCacheNodesOfferings service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodesOfferingNotFoundException"> The requested cache node offering does not exist. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeReservedCacheNodesOfferingsAsync(Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedCacheNodesOfferings operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedCacheNodesOfferings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeSnapshots"> <summary> The <i>DescribeSnapshots</i> action returns information about cache cluster snapshots. By default, <i>DescribeSnapshots</i> lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. </summary> <returns>The response from the DescribeSnapshots service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"> The requested snapshot name does not refer to an existing snapshot. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeSnapshots(Amazon.ElastiCache.Model.DescribeSnapshotsRequest)"> <summary> The <i>DescribeSnapshots</i> action returns information about cache cluster snapshots. By default, <i>DescribeSnapshots</i> lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots service method.</param> <returns>The response from the DescribeSnapshots service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"> The requested snapshot name does not refer to an existing snapshot. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.DescribeSnapshotsAsync(Amazon.ElastiCache.Model.DescribeSnapshotsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSnapshots operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.ListTagsForResource(Amazon.ElastiCache.Model.ListTagsForResourceRequest)"> <summary> The <i>ListTagsForResource</i> action lists all cost allocation tags currently on the named resource. A <i>cost allocation tag</i> is a key-value pair where the key is case-sensitive and the value is optional. Cost allocation tags can be used to categorize and track your AWS costs. <para> You can have a maximum of 10 cost allocation tags on an ElastiCache resource. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/BestPractices.html">Using Cost Allocation Tags in Amazon ElastiCache</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResource service method.</param> <returns>The response from the ListTagsForResource service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidARNException"> The requested Amazon Resource Name (ARN) does not refer to an existing resource. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"> The requested snapshot name does not refer to an existing snapshot. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.ListTagsForResourceAsync(Amazon.ElastiCache.Model.ListTagsForResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTagsForResource operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.ModifyCacheCluster(Amazon.ElastiCache.Model.ModifyCacheClusterRequest)"> <summary> The <i>ModifyCacheCluster</i> action modifies the settings for a cache cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values. </summary> <param name="request">Container for the necessary parameters to execute the ModifyCacheCluster service method.</param> <returns>The response from the ModifyCacheCluster service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InsufficientCacheClusterCapacityException"> The requested cache node type is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"> The requested cache cluster is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"> The current state of the cache security group does not allow deletion. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidVPCNetworkStateException"> The VPC network is in an invalid state. </exception> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForClusterExceededException"> The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForCustomerExceededException"> The request cannot be processed because it would exceed the allowed number of cache nodes per customer. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.ModifyCacheClusterAsync(Amazon.ElastiCache.Model.ModifyCacheClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyCacheCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyCacheCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.ModifyCacheParameterGroup(Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest)"> <summary> The <i>ModifyCacheParameterGroup</i> action modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs. </summary> <param name="request">Container for the necessary parameters to execute the ModifyCacheParameterGroup service method.</param> <returns>The response from the ModifyCacheParameterGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"> The current state of the cache parameter group does not allow the requested action to occur. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.ModifyCacheParameterGroupAsync(Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyCacheParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyCacheParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.ModifyCacheSubnetGroup(Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest)"> <summary> The <i>ModifyCacheSubnetGroup</i> action modifies an existing cache subnet group. </summary> <param name="request">Container for the necessary parameters to execute the ModifyCacheSubnetGroup service method.</param> <returns>The response from the ModifyCacheSubnetGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"> The requested cache subnet group name does not refer to an existing cache subnet group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetQuotaExceededException"> The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidSubnetException"> An invalid subnet identifier was specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.SubnetInUseException"> The requested subnet is being used by another cache subnet group. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.ModifyCacheSubnetGroupAsync(Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyCacheSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyCacheSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.ModifyReplicationGroup(Amazon.ElastiCache.Model.ModifyReplicationGroupRequest)"> <summary> The <i>ModifyReplicationGroup</i> action modifies the settings for a replication group. </summary> <param name="request">Container for the necessary parameters to execute the ModifyReplicationGroup service method.</param> <returns>The response from the ModifyReplicationGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InsufficientCacheClusterCapacityException"> The requested cache node type is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"> The requested cache cluster is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"> The current state of the cache security group does not allow deletion. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidReplicationGroupStateException"> The requested replication group is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidVPCNetworkStateException"> The VPC network is in an invalid state. </exception> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForClusterExceededException"> The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForCustomerExceededException"> The request cannot be processed because it would exceed the allowed number of cache nodes per customer. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"> The specified replication group does not exist. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.ModifyReplicationGroupAsync(Amazon.ElastiCache.Model.ModifyReplicationGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyReplicationGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyReplicationGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.PurchaseReservedCacheNodesOffering(Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest)"> <summary> The <i>PurchaseReservedCacheNodesOffering</i> action allows you to purchase a reserved cache node offering. </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedCacheNodesOffering service method.</param> <returns>The response from the PurchaseReservedCacheNodesOffering service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodeAlreadyExistsException"> You already have a reservation with the given identifier. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodeQuotaExceededException"> The request cannot be processed because it would exceed the user's cache node quota. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodesOfferingNotFoundException"> The requested cache node offering does not exist. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.PurchaseReservedCacheNodesOfferingAsync(Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PurchaseReservedCacheNodesOffering operation. </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedCacheNodesOffering operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.RebootCacheCluster(Amazon.ElastiCache.Model.RebootCacheClusterRequest)"> <summary> The <i>RebootCacheCluster</i> action reboots some, or all, of the cache nodes within a provisioned cache cluster. This API will apply any modified cache parameter groups to the cache cluster. The reboot action takes place as soon as possible, and results in a momentary outage to the cache cluster. During the reboot, the cache cluster status is set to REBOOTING. <para> The reboot causes the contents of the cache (for each cache node being rebooted) to be lost. </para> <para> When the reboot is complete, a cache cluster event is created. </para> </summary> <param name="request">Container for the necessary parameters to execute the RebootCacheCluster service method.</param> <returns>The response from the RebootCacheCluster service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"> The requested cache cluster is not in the <i>available</i> state. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.RebootCacheClusterAsync(Amazon.ElastiCache.Model.RebootCacheClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RebootCacheCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the RebootCacheCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.RemoveTagsFromResource(Amazon.ElastiCache.Model.RemoveTagsFromResourceRequest)"> <summary> The <i>RemoveTagsFromResource</i> action removes the tags identified by the <code>TagKeys</code> list from the named resource. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromResource service method.</param> <returns>The response from the RemoveTagsFromResource service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidARNException"> The requested Amazon Resource Name (ARN) does not refer to an existing resource. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"> The requested snapshot name does not refer to an existing snapshot. </exception> <exception cref="T:Amazon.ElastiCache.Model.TagNotFoundException"> The requested tag was not found on this resource. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.RemoveTagsFromResourceAsync(Amazon.ElastiCache.Model.RemoveTagsFromResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTagsFromResource operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.ResetCacheParameterGroup(Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest)"> <summary> The <i>ResetCacheParameterGroup</i> action modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the <i>ResetAllParameters</i> and <i>CacheParameterGroupName</i> parameters. </summary> <param name="request">Container for the necessary parameters to execute the ResetCacheParameterGroup service method.</param> <returns>The response from the ResetCacheParameterGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"> The current state of the cache parameter group does not allow the requested action to occur. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.ResetCacheParameterGroupAsync(Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetCacheParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetCacheParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.RevokeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest)"> <summary> The <i>RevokeCacheSecurityGroupIngress</i> action revokes ingress from a cache security group. Use this action to disallow access from an Amazon EC2 security group that had been previously authorized. </summary> <param name="request">Container for the necessary parameters to execute the RevokeCacheSecurityGroupIngress service method.</param> <returns>The response from the RevokeCacheSecurityGroupIngress service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.AuthorizationNotFoundException"> The specified Amazon EC2 security group is not authorized for the specified cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"> The current state of the cache security group does not allow deletion. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.IAmazonElastiCache.RevokeCacheSecurityGroupIngressAsync(Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RevokeCacheSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeCacheSecurityGroupIngress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.#ctor"> <summary> Constructs AmazonElastiCacheClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonElastiCacheClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.#ctor(Amazon.ElastiCache.AmazonElastiCacheConfig)"> <summary> Constructs AmazonElastiCacheClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonElastiCacheClient Configuration Object</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonElastiCacheClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElastiCacheClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.ElastiCache.AmazonElastiCacheConfig)"> <summary> Constructs AmazonElastiCacheClient with AWS Credentials and an AmazonElastiCacheClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonElastiCacheClient Configuration Object</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonElastiCacheClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElastiCacheClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.#ctor(System.String,System.String,Amazon.ElastiCache.AmazonElastiCacheConfig)"> <summary> Constructs AmazonElastiCacheClient with AWS Access Key ID, AWS Secret Key and an AmazonElastiCacheClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonElastiCacheClient Configuration Object</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonElastiCacheClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElastiCacheClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.#ctor(System.String,System.String,System.String,Amazon.ElastiCache.AmazonElastiCacheConfig)"> <summary> Constructs AmazonElastiCacheClient with AWS Access Key ID, AWS Secret Key and an AmazonElastiCacheClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonElastiCacheClient Configuration Object</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.AddTagsToResource(Amazon.ElastiCache.Model.AddTagsToResourceRequest)"> <summary> The <i>AddTagsToResource</i> action adds up to 10 cost allocation tags to the named resource. A <i>cost allocation tag</i> is a key-value pair where the key and value are case-sensitive. Cost allocation tags can be used to categorize and track your AWS costs. <para> When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Tagging.html">Using Cost Allocation Tags in Amazon ElastiCache</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToResource service method.</param> <returns>The response from the AddTagsToResource service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidARNException"> The requested Amazon Resource Name (ARN) does not refer to an existing resource. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"> The requested snapshot name does not refer to an existing snapshot. </exception> <exception cref="T:Amazon.ElastiCache.Model.TagQuotaPerResourceExceededException"> The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 10. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.AddTagsToResourceAsync(Amazon.ElastiCache.Model.AddTagsToResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTagsToResource operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.AuthorizeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest)"> <summary> The <i>AuthorizeCacheSecurityGroupIngress</i> action allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism. <note>You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region. </note> </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeCacheSecurityGroupIngress service method.</param> <returns>The response from the AuthorizeCacheSecurityGroupIngress service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.AuthorizationAlreadyExistsException"> The specified Amazon EC2 security group is already authorized for the specified cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"> The current state of the cache security group does not allow deletion. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.AuthorizeCacheSecurityGroupIngressAsync(Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AuthorizeCacheSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeCacheSecurityGroupIngress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CopySnapshot(Amazon.ElastiCache.Model.CopySnapshotRequest)"> <summary> The <i>CopySnapshot</i> action makes a copy of an existing snapshot. </summary> <param name="request">Container for the necessary parameters to execute the CopySnapshot service method.</param> <returns>The response from the CopySnapshot service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidSnapshotStateException"> The current state of the snapshot does not allow the requested action to occur. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"> You already have a snapshot with the given name. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"> The requested snapshot name does not refer to an existing snapshot. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"> The request cannot be processed because it would exceed the maximum number of snapshots. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CopySnapshotAsync(Amazon.ElastiCache.Model.CopySnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopySnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CopySnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateCacheCluster(Amazon.ElastiCache.Model.CreateCacheClusterRequest)"> <summary> The <i>CreateCacheCluster</i> action creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis. </summary> <param name="request">Container for the necessary parameters to execute the CreateCacheCluster service method.</param> <returns>The response from the CreateCacheCluster service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterAlreadyExistsException"> You already have a cache cluster with the given identifier. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"> The requested cache subnet group name does not refer to an existing cache subnet group. </exception> <exception cref="T:Amazon.ElastiCache.Model.ClusterQuotaForCustomerExceededException"> The request cannot be processed because it would exceed the allowed number of cache clusters per customer. </exception> <exception cref="T:Amazon.ElastiCache.Model.InsufficientCacheClusterCapacityException"> The requested cache node type is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidReplicationGroupStateException"> The requested replication group is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidVPCNetworkStateException"> The VPC network is in an invalid state. </exception> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForClusterExceededException"> The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForCustomerExceededException"> The request cannot be processed because it would exceed the allowed number of cache nodes per customer. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"> The specified replication group does not exist. </exception> <exception cref="T:Amazon.ElastiCache.Model.TagQuotaPerResourceExceededException"> The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 10. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateCacheClusterAsync(Amazon.ElastiCache.Model.CreateCacheClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCacheCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCacheCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateCacheParameterGroup(Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest)"> <summary> The <i>CreateCacheParameterGroup</i> action creates a new cache parameter group. A cache parameter group is a collection of parameters that you apply to all of the nodes in a cache cluster. </summary> <param name="request">Container for the necessary parameters to execute the CreateCacheParameterGroup service method.</param> <returns>The response from the CreateCacheParameterGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupAlreadyExistsException"> A cache parameter group with the requested name already exists. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupQuotaExceededException"> The request cannot be processed because it would exceed the maximum number of cache security groups. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"> The current state of the cache parameter group does not allow the requested action to occur. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateCacheParameterGroupAsync(Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCacheParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCacheParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateCacheSecurityGroup(Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest)"> <summary> The <i>CreateCacheSecurityGroup</i> action creates a new cache security group. Use a cache security group to control access to one or more cache clusters. <para> Cache security groups are only used when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cache cluster inside of a VPC, use a cache subnet group instead. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html">CreateCacheSubnetGroup</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateCacheSecurityGroup service method.</param> <returns>The response from the CreateCacheSecurityGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupAlreadyExistsException"> A cache security group with the specified name already exists. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupQuotaExceededException"> The request cannot be processed because it would exceed the allowed number of cache security groups. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateCacheSecurityGroupAsync(Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCacheSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCacheSecurityGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateCacheSubnetGroup(Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest)"> <summary> The <i>CreateCacheSubnetGroup</i> action creates a new cache subnet group. <para> Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC). </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateCacheSubnetGroup service method.</param> <returns>The response from the CreateCacheSubnetGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupAlreadyExistsException"> The requested cache subnet group name is already in use by an existing cache subnet group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupQuotaExceededException"> The request cannot be processed because it would exceed the allowed number of cache subnet groups. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetQuotaExceededException"> The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidSubnetException"> An invalid subnet identifier was specified. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateCacheSubnetGroupAsync(Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCacheSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCacheSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateReplicationGroup(Amazon.ElastiCache.Model.CreateReplicationGroupRequest)"> <summary> The <i>CreateReplicationGroup</i> action creates a replication group. A replication group is a collection of cache clusters, where one of the cache clusters is a read/write primary and the others are read-only replicas. Writes to the primary are automatically propagated to the replicas. <para> When you create a replication group, you must specify an existing cache cluster that is in the primary role. When the replication group has been successfully created, you can add one or more read replica replicas to it, up to a total of five read replicas. </para> <para> <b>Note:</b> This action is valid only for Redis. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateReplicationGroup service method.</param> <returns>The response from the CreateReplicationGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"> The requested cache subnet group name does not refer to an existing cache subnet group. </exception> <exception cref="T:Amazon.ElastiCache.Model.ClusterQuotaForCustomerExceededException"> The request cannot be processed because it would exceed the allowed number of cache clusters per customer. </exception> <exception cref="T:Amazon.ElastiCache.Model.InsufficientCacheClusterCapacityException"> The requested cache node type is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"> The requested cache cluster is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidVPCNetworkStateException"> The VPC network is in an invalid state. </exception> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForClusterExceededException"> The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForCustomerExceededException"> The request cannot be processed because it would exceed the allowed number of cache nodes per customer. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupAlreadyExistsException"> The specified replication group already exists. </exception> <exception cref="T:Amazon.ElastiCache.Model.TagQuotaPerResourceExceededException"> The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 10. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateReplicationGroupAsync(Amazon.ElastiCache.Model.CreateReplicationGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateReplicationGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateReplicationGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateSnapshot(Amazon.ElastiCache.Model.CreateSnapshotRequest)"> <summary> The <i>CreateSnapshot</i> action creates a copy of an entire cache cluster at a specific moment in time. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot service method.</param> <returns>The response from the CreateSnapshot service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"> The requested cache cluster is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"> You already have a snapshot with the given name. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotFeatureNotSupportedException"> You attempted one of the following actions: <ul> <li> <para> Creating a snapshot of a Redis cache cluster running on a <i>t1.micro</i> cache node. </para> </li> <li> <para> Creating a snapshot of a cache cluster that is running Memcached rather than Redis. </para> </li> </ul> <para> Neither of these are supported by ElastiCache. </para> </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"> The request cannot be processed because it would exceed the maximum number of snapshots. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateSnapshotAsync(Amazon.ElastiCache.Model.CreateSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteCacheCluster(Amazon.ElastiCache.Model.DeleteCacheClusterRequest)"> <summary> The <i>DeleteCacheCluster</i> action deletes a previously provisioned cache cluster. <i>DeleteCacheCluster</i> deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this action. <para> This API cannot be used to delete a cache cluster that is the last read replica of a replication group that has Multi-AZ mode enabled. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteCacheCluster service method.</param> <returns>The response from the DeleteCacheCluster service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"> The requested cache cluster is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"> You already have a snapshot with the given name. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotFeatureNotSupportedException"> You attempted one of the following actions: <ul> <li> <para> Creating a snapshot of a Redis cache cluster running on a <i>t1.micro</i> cache node. </para> </li> <li> <para> Creating a snapshot of a cache cluster that is running Memcached rather than Redis. </para> </li> </ul> <para> Neither of these are supported by ElastiCache. </para> </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"> The request cannot be processed because it would exceed the maximum number of snapshots. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteCacheClusterAsync(Amazon.ElastiCache.Model.DeleteCacheClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCacheCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCacheCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteCacheParameterGroup(Amazon.ElastiCache.Model.DeleteCacheParameterGroupRequest)"> <summary> The <i>DeleteCacheParameterGroup</i> action deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCacheParameterGroup service method.</param> <returns>The response from the DeleteCacheParameterGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"> The current state of the cache parameter group does not allow the requested action to occur. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteCacheParameterGroupAsync(Amazon.ElastiCache.Model.DeleteCacheParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCacheParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCacheParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteCacheSecurityGroup(Amazon.ElastiCache.Model.DeleteCacheSecurityGroupRequest)"> <summary> The <i>DeleteCacheSecurityGroup</i> action deletes a cache security group. <note>You cannot delete a cache security group if it is associated with any cache clusters.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteCacheSecurityGroup service method.</param> <returns>The response from the DeleteCacheSecurityGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"> The current state of the cache security group does not allow deletion. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteCacheSecurityGroupAsync(Amazon.ElastiCache.Model.DeleteCacheSecurityGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCacheSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCacheSecurityGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteCacheSubnetGroup(Amazon.ElastiCache.Model.DeleteCacheSubnetGroupRequest)"> <summary> The <i>DeleteCacheSubnetGroup</i> action deletes a cache subnet group. <note>You cannot delete a cache subnet group if it is associated with any cache clusters.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteCacheSubnetGroup service method.</param> <returns>The response from the DeleteCacheSubnetGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupInUseException"> The requested cache subnet group is currently in use. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"> The requested cache subnet group name does not refer to an existing cache subnet group. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteCacheSubnetGroupAsync(Amazon.ElastiCache.Model.DeleteCacheSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCacheSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCacheSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteReplicationGroup(Amazon.ElastiCache.Model.DeleteReplicationGroupRequest)"> <summary> The <i>DeleteReplicationGroup</i> action deletes an existing replication group. By default, this action deletes the entire replication group, including the primary cluster and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary cluster. <para> When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteReplicationGroup service method.</param> <returns>The response from the DeleteReplicationGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidReplicationGroupStateException"> The requested replication group is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"> The specified replication group does not exist. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"> You already have a snapshot with the given name. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotFeatureNotSupportedException"> You attempted one of the following actions: <ul> <li> <para> Creating a snapshot of a Redis cache cluster running on a <i>t1.micro</i> cache node. </para> </li> <li> <para> Creating a snapshot of a cache cluster that is running Memcached rather than Redis. </para> </li> </ul> <para> Neither of these are supported by ElastiCache. </para> </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"> The request cannot be processed because it would exceed the maximum number of snapshots. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteReplicationGroupAsync(Amazon.ElastiCache.Model.DeleteReplicationGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteReplicationGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteReplicationGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteSnapshot(Amazon.ElastiCache.Model.DeleteSnapshotRequest)"> <summary> The <i>DeleteSnapshot</i> action deletes an existing snapshot. When you receive a successful response from this action, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this action. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot service method.</param> <returns>The response from the DeleteSnapshot service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidSnapshotStateException"> The current state of the snapshot does not allow the requested action to occur. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"> The requested snapshot name does not refer to an existing snapshot. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteSnapshotAsync(Amazon.ElastiCache.Model.DeleteSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheClusters"> <summary> The <i>DescribeCacheClusters</i> action returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied. <para> By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional <i>ShowDetails</i> flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint. </para> <para> If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned. </para> <para> If the cluster is in the DELETING state, only cluster level information will be displayed. </para> <para> If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is <i>available</i>, the cluster is ready for use. </para> <para> If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed. </para> </summary> <returns>The response from the DescribeCacheClusters service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheClusters(Amazon.ElastiCache.Model.DescribeCacheClustersRequest)"> <summary> The <i>DescribeCacheClusters</i> action returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied. <para> By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional <i>ShowDetails</i> flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint. </para> <para> If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned. </para> <para> If the cluster is in the DELETING state, only cluster level information will be displayed. </para> <para> If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is <i>available</i>, the cluster is ready for use. </para> <para> If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheClusters service method.</param> <returns>The response from the DescribeCacheClusters service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheClustersAsync(Amazon.ElastiCache.Model.DescribeCacheClustersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCacheClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheClusters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheEngineVersions"> <summary> The <i>DescribeCacheEngineVersions</i> action returns a list of the available cache engines and their versions. </summary> <returns>The response from the DescribeCacheEngineVersions service method, as returned by ElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheEngineVersions(Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest)"> <summary> The <i>DescribeCacheEngineVersions</i> action returns a list of the available cache engines and their versions. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheEngineVersions service method.</param> <returns>The response from the DescribeCacheEngineVersions service method, as returned by ElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheEngineVersionsAsync(Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCacheEngineVersions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheEngineVersions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheParameterGroups"> <summary> The <i>DescribeCacheParameterGroups</i> action returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group. </summary> <returns>The response from the DescribeCacheParameterGroups service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheParameterGroups(Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest)"> <summary> The <i>DescribeCacheParameterGroups</i> action returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheParameterGroups service method.</param> <returns>The response from the DescribeCacheParameterGroups service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheParameterGroupsAsync(Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCacheParameterGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheParameterGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheParameters(Amazon.ElastiCache.Model.DescribeCacheParametersRequest)"> <summary> The <i>DescribeCacheParameters</i> action returns the detailed parameter list for a particular cache parameter group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheParameters service method.</param> <returns>The response from the DescribeCacheParameters service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheParametersAsync(Amazon.ElastiCache.Model.DescribeCacheParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCacheParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheSecurityGroups"> <summary> The <i>DescribeCacheSecurityGroups</i> action returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group. </summary> <returns>The response from the DescribeCacheSecurityGroups service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheSecurityGroups(Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest)"> <summary> The <i>DescribeCacheSecurityGroups</i> action returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheSecurityGroups service method.</param> <returns>The response from the DescribeCacheSecurityGroups service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheSecurityGroupsAsync(Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCacheSecurityGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheSecurityGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheSubnetGroups"> <summary> The <i>DescribeCacheSubnetGroups</i> action returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group. </summary> <returns>The response from the DescribeCacheSubnetGroups service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"> The requested cache subnet group name does not refer to an existing cache subnet group. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheSubnetGroups(Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest)"> <summary> The <i>DescribeCacheSubnetGroups</i> action returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheSubnetGroups service method.</param> <returns>The response from the DescribeCacheSubnetGroups service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"> The requested cache subnet group name does not refer to an existing cache subnet group. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheSubnetGroupsAsync(Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCacheSubnetGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCacheSubnetGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeEngineDefaultParameters(Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest)"> <summary> The <i>DescribeEngineDefaultParameters</i> action returns the default engine and system parameter information for the specified cache engine. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEngineDefaultParameters service method.</param> <returns>The response from the DescribeEngineDefaultParameters service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeEngineDefaultParametersAsync(Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEngineDefaultParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEngineDefaultParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeEvents"> <summary> The <i>DescribeEvents</i> action returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter. <para> By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary. </para> </summary> <returns>The response from the DescribeEvents service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeEvents(Amazon.ElastiCache.Model.DescribeEventsRequest)"> <summary> The <i>DescribeEvents</i> action returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter. <para> By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents service method.</param> <returns>The response from the DescribeEvents service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeEventsAsync(Amazon.ElastiCache.Model.DescribeEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeReplicationGroups"> <summary> The <i>DescribeReplicationGroups</i> action returns information about a particular replication group. If no identifier is specified, <i>DescribeReplicationGroups</i> returns information about all replication groups. </summary> <returns>The response from the DescribeReplicationGroups service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"> The specified replication group does not exist. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeReplicationGroups(Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest)"> <summary> The <i>DescribeReplicationGroups</i> action returns information about a particular replication group. If no identifier is specified, <i>DescribeReplicationGroups</i> returns information about all replication groups. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReplicationGroups service method.</param> <returns>The response from the DescribeReplicationGroups service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"> The specified replication group does not exist. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeReplicationGroupsAsync(Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReplicationGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReplicationGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeReservedCacheNodes"> <summary> The <i>DescribeReservedCacheNodes</i> action returns information about reserved cache nodes for this account, or about a specified reserved cache node. </summary> <returns>The response from the DescribeReservedCacheNodes service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodeNotFoundException"> The requested reserved cache node was not found. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeReservedCacheNodes(Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest)"> <summary> The <i>DescribeReservedCacheNodes</i> action returns information about reserved cache nodes for this account, or about a specified reserved cache node. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedCacheNodes service method.</param> <returns>The response from the DescribeReservedCacheNodes service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodeNotFoundException"> The requested reserved cache node was not found. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeReservedCacheNodesAsync(Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedCacheNodes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedCacheNodes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeReservedCacheNodesOfferings"> <summary> The <i>DescribeReservedCacheNodesOfferings</i> action lists available reserved cache node offerings. </summary> <returns>The response from the DescribeReservedCacheNodesOfferings service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodesOfferingNotFoundException"> The requested cache node offering does not exist. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeReservedCacheNodesOfferings(Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest)"> <summary> The <i>DescribeReservedCacheNodesOfferings</i> action lists available reserved cache node offerings. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedCacheNodesOfferings service method.</param> <returns>The response from the DescribeReservedCacheNodesOfferings service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodesOfferingNotFoundException"> The requested cache node offering does not exist. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeReservedCacheNodesOfferingsAsync(Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedCacheNodesOfferings operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedCacheNodesOfferings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeSnapshots"> <summary> The <i>DescribeSnapshots</i> action returns information about cache cluster snapshots. By default, <i>DescribeSnapshots</i> lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. </summary> <returns>The response from the DescribeSnapshots service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"> The requested snapshot name does not refer to an existing snapshot. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeSnapshots(Amazon.ElastiCache.Model.DescribeSnapshotsRequest)"> <summary> The <i>DescribeSnapshots</i> action returns information about cache cluster snapshots. By default, <i>DescribeSnapshots</i> lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots service method.</param> <returns>The response from the DescribeSnapshots service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"> The requested snapshot name does not refer to an existing snapshot. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeSnapshotsAsync(Amazon.ElastiCache.Model.DescribeSnapshotsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSnapshots operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.ListTagsForResource(Amazon.ElastiCache.Model.ListTagsForResourceRequest)"> <summary> The <i>ListTagsForResource</i> action lists all cost allocation tags currently on the named resource. A <i>cost allocation tag</i> is a key-value pair where the key is case-sensitive and the value is optional. Cost allocation tags can be used to categorize and track your AWS costs. <para> You can have a maximum of 10 cost allocation tags on an ElastiCache resource. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/BestPractices.html">Using Cost Allocation Tags in Amazon ElastiCache</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResource service method.</param> <returns>The response from the ListTagsForResource service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidARNException"> The requested Amazon Resource Name (ARN) does not refer to an existing resource. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"> The requested snapshot name does not refer to an existing snapshot. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.ListTagsForResourceAsync(Amazon.ElastiCache.Model.ListTagsForResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTagsForResource operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.ModifyCacheCluster(Amazon.ElastiCache.Model.ModifyCacheClusterRequest)"> <summary> The <i>ModifyCacheCluster</i> action modifies the settings for a cache cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values. </summary> <param name="request">Container for the necessary parameters to execute the ModifyCacheCluster service method.</param> <returns>The response from the ModifyCacheCluster service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InsufficientCacheClusterCapacityException"> The requested cache node type is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"> The requested cache cluster is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"> The current state of the cache security group does not allow deletion. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidVPCNetworkStateException"> The VPC network is in an invalid state. </exception> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForClusterExceededException"> The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForCustomerExceededException"> The request cannot be processed because it would exceed the allowed number of cache nodes per customer. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.ModifyCacheClusterAsync(Amazon.ElastiCache.Model.ModifyCacheClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyCacheCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyCacheCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.ModifyCacheParameterGroup(Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest)"> <summary> The <i>ModifyCacheParameterGroup</i> action modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs. </summary> <param name="request">Container for the necessary parameters to execute the ModifyCacheParameterGroup service method.</param> <returns>The response from the ModifyCacheParameterGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"> The current state of the cache parameter group does not allow the requested action to occur. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.ModifyCacheParameterGroupAsync(Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyCacheParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyCacheParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.ModifyCacheSubnetGroup(Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest)"> <summary> The <i>ModifyCacheSubnetGroup</i> action modifies an existing cache subnet group. </summary> <param name="request">Container for the necessary parameters to execute the ModifyCacheSubnetGroup service method.</param> <returns>The response from the ModifyCacheSubnetGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"> The requested cache subnet group name does not refer to an existing cache subnet group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetQuotaExceededException"> The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidSubnetException"> An invalid subnet identifier was specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.SubnetInUseException"> The requested subnet is being used by another cache subnet group. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.ModifyCacheSubnetGroupAsync(Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyCacheSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyCacheSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.ModifyReplicationGroup(Amazon.ElastiCache.Model.ModifyReplicationGroupRequest)"> <summary> The <i>ModifyReplicationGroup</i> action modifies the settings for a replication group. </summary> <param name="request">Container for the necessary parameters to execute the ModifyReplicationGroup service method.</param> <returns>The response from the ModifyReplicationGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InsufficientCacheClusterCapacityException"> The requested cache node type is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"> The requested cache cluster is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"> The current state of the cache security group does not allow deletion. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidReplicationGroupStateException"> The requested replication group is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidVPCNetworkStateException"> The VPC network is in an invalid state. </exception> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForClusterExceededException"> The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForCustomerExceededException"> The request cannot be processed because it would exceed the allowed number of cache nodes per customer. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"> The specified replication group does not exist. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.ModifyReplicationGroupAsync(Amazon.ElastiCache.Model.ModifyReplicationGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyReplicationGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyReplicationGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.PurchaseReservedCacheNodesOffering(Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest)"> <summary> The <i>PurchaseReservedCacheNodesOffering</i> action allows you to purchase a reserved cache node offering. </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedCacheNodesOffering service method.</param> <returns>The response from the PurchaseReservedCacheNodesOffering service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodeAlreadyExistsException"> You already have a reservation with the given identifier. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodeQuotaExceededException"> The request cannot be processed because it would exceed the user's cache node quota. </exception> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodesOfferingNotFoundException"> The requested cache node offering does not exist. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.PurchaseReservedCacheNodesOfferingAsync(Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PurchaseReservedCacheNodesOffering operation. </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedCacheNodesOffering operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.RebootCacheCluster(Amazon.ElastiCache.Model.RebootCacheClusterRequest)"> <summary> The <i>RebootCacheCluster</i> action reboots some, or all, of the cache nodes within a provisioned cache cluster. This API will apply any modified cache parameter groups to the cache cluster. The reboot action takes place as soon as possible, and results in a momentary outage to the cache cluster. During the reboot, the cache cluster status is set to REBOOTING. <para> The reboot causes the contents of the cache (for each cache node being rebooted) to be lost. </para> <para> When the reboot is complete, a cache cluster event is created. </para> </summary> <param name="request">Container for the necessary parameters to execute the RebootCacheCluster service method.</param> <returns>The response from the RebootCacheCluster service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"> The requested cache cluster is not in the <i>available</i> state. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.RebootCacheClusterAsync(Amazon.ElastiCache.Model.RebootCacheClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RebootCacheCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the RebootCacheCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.RemoveTagsFromResource(Amazon.ElastiCache.Model.RemoveTagsFromResourceRequest)"> <summary> The <i>RemoveTagsFromResource</i> action removes the tags identified by the <code>TagKeys</code> list from the named resource. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromResource service method.</param> <returns>The response from the RemoveTagsFromResource service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> The requested cache cluster ID does not refer to an existing cache cluster. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidARNException"> The requested Amazon Resource Name (ARN) does not refer to an existing resource. </exception> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"> The requested snapshot name does not refer to an existing snapshot. </exception> <exception cref="T:Amazon.ElastiCache.Model.TagNotFoundException"> The requested tag was not found on this resource. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.RemoveTagsFromResourceAsync(Amazon.ElastiCache.Model.RemoveTagsFromResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTagsFromResource operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.ResetCacheParameterGroup(Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest)"> <summary> The <i>ResetCacheParameterGroup</i> action modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the <i>ResetAllParameters</i> and <i>CacheParameterGroupName</i> parameters. </summary> <param name="request">Container for the necessary parameters to execute the ResetCacheParameterGroup service method.</param> <returns>The response from the ResetCacheParameterGroup service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> The requested cache parameter group name does not refer to an existing cache parameter group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"> The current state of the cache parameter group does not allow the requested action to occur. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.ResetCacheParameterGroupAsync(Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetCacheParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetCacheParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.RevokeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest)"> <summary> The <i>RevokeCacheSecurityGroupIngress</i> action revokes ingress from a cache security group. Use this action to disallow access from an Amazon EC2 security group that had been previously authorized. </summary> <param name="request">Container for the necessary parameters to execute the RevokeCacheSecurityGroupIngress service method.</param> <returns>The response from the RevokeCacheSecurityGroupIngress service method, as returned by ElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.AuthorizationNotFoundException"> The specified Amazon EC2 security group is not authorized for the specified cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> The requested cache security group name does not refer to an existing cache security group. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"> The current state of the cache security group does not allow deletion. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> Two or more incompatible parameters were specified. </exception> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.RevokeCacheSecurityGroupIngressAsync(Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RevokeCacheSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeCacheSecurityGroupIngress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient"> <summary> Implementation for accessing ElasticBeanstalk AWS Elastic Beanstalk <para> This is the AWS Elastic Beanstalk API Reference. This guide provides detailed information about AWS Elastic Beanstalk actions, data types, parameters, and errors. </para> <para> AWS Elastic Beanstalk is a tool that makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on Amazon Web Services cloud resources. </para> <para> For more information about this product, go to the <a href="http://aws.amazon.com/elasticbeanstalk/">AWS Elastic Beanstalk</a> details page. The location of the latest AWS Elastic Beanstalk WSDL is <a href="http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl">http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl</a>. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to <a href="https://aws.amazon.com/tools/">Tools for Amazon Web Services</a>. </para> <para> <b>Endpoints</b> </para> <para> For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region">Regions and Endpoints</a> in the <i>Amazon Web Services Glossary</i>. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk"> <summary> Interface for accessing ElasticBeanstalk AWS Elastic Beanstalk <para> This is the AWS Elastic Beanstalk API Reference. This guide provides detailed information about AWS Elastic Beanstalk actions, data types, parameters, and errors. </para> <para> AWS Elastic Beanstalk is a tool that makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on Amazon Web Services cloud resources. </para> <para> For more information about this product, go to the <a href="http://aws.amazon.com/elasticbeanstalk/">AWS Elastic Beanstalk</a> details page. The location of the latest AWS Elastic Beanstalk WSDL is <a href="http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl">http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl</a>. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to <a href="https://aws.amazon.com/tools/">Tools for Amazon Web Services</a>. </para> <para> <b>Endpoints</b> </para> <para> For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region">Regions and Endpoints</a> in the <i>Amazon Web Services Glossary</i>. </para> </summary> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.AbortEnvironmentUpdate(Amazon.ElasticBeanstalk.Model.AbortEnvironmentUpdateRequest)"> <summary> Cancels in-progress environment configuration update or application version deployment. </summary> <param name="request">Container for the necessary parameters to execute the AbortEnvironmentUpdate service method.</param> <returns>The response from the AbortEnvironmentUpdate service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.AbortEnvironmentUpdateAsync(Amazon.ElasticBeanstalk.Model.AbortEnvironmentUpdateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AbortEnvironmentUpdate operation. </summary> <param name="request">Container for the necessary parameters to execute the AbortEnvironmentUpdate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.CheckDNSAvailability(Amazon.ElasticBeanstalk.Model.CheckDNSAvailabilityRequest)"> <summary> Checks if the specified CNAME is available. </summary> <param name="request">Container for the necessary parameters to execute the CheckDNSAvailability service method.</param> <returns>The response from the CheckDNSAvailability service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.CheckDNSAvailabilityAsync(Amazon.ElasticBeanstalk.Model.CheckDNSAvailabilityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CheckDNSAvailability operation. </summary> <param name="request">Container for the necessary parameters to execute the CheckDNSAvailability operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.ComposeEnvironments(Amazon.ElasticBeanstalk.Model.ComposeEnvironmentsRequest)"> <summary> Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named <code>env.yaml</code>. See <a href="http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-mgmt-compose.html">Compose Environments</a> for details. </summary> <param name="request">Container for the necessary parameters to execute the ComposeEnvironments service method.</param> <returns>The response from the ComposeEnvironments service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyEnvironmentsException"> The specified account has reached its limit of environments. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.ComposeEnvironmentsAsync(Amazon.ElasticBeanstalk.Model.ComposeEnvironmentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ComposeEnvironments operation. </summary> <param name="request">Container for the necessary parameters to execute the ComposeEnvironments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.CreateApplication(Amazon.ElasticBeanstalk.Model.CreateApplicationRequest)"> <summary> Creates an application that has one configuration template named <code>default</code> and no application versions. </summary> <param name="request">Container for the necessary parameters to execute the CreateApplication service method.</param> <returns>The response from the CreateApplication service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyApplicationsException"> The specified account has reached its limit of applications. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.CreateApplicationAsync(Amazon.ElasticBeanstalk.Model.CreateApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.CreateApplicationVersion(Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest)"> <summary> Creates an application version for the specified application. <note>Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version. </note> </summary> <param name="request">Container for the necessary parameters to execute the CreateApplicationVersion service method.</param> <returns>The response from the CreateApplicationVersion service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.S3LocationNotInServiceRegionException"> The specified S3 bucket does not belong to the S3 region in which the service is running. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyApplicationsException"> The specified account has reached its limit of applications. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyApplicationVersionsException"> The specified account has reached its limit of application versions. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.CreateApplicationVersionAsync(Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateApplicationVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateApplicationVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.CreateConfigurationTemplate(Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest)"> <summary> Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings. <para> Related Topics </para> <ul> <li> <a>DescribeConfigurationOptions</a> </li> <li> <a>DescribeConfigurationSettings</a> </li> <li> <a>ListAvailableSolutionStacks</a> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the CreateConfigurationTemplate service method.</param> <returns>The response from the CreateConfigurationTemplate service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyConfigurationTemplatesException"> The specified account has reached its limit of configuration templates. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.CreateConfigurationTemplateAsync(Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateConfigurationTemplate operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateConfigurationTemplate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.CreateEnvironment(Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest)"> <summary> Launches an environment for the specified application using the specified configuration. </summary> <param name="request">Container for the necessary parameters to execute the CreateEnvironment service method.</param> <returns>The response from the CreateEnvironment service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyEnvironmentsException"> The specified account has reached its limit of environments. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.CreateEnvironmentAsync(Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateEnvironment operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateEnvironment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.CreateStorageLocation"> <summary> Creates the Amazon S3 storage location for the account. <para> This location is used to store user log files. </para> </summary> <returns>The response from the CreateStorageLocation service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.S3SubscriptionRequiredException"> The specified account does not have a subscription to Amazon S3. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyBucketsException"> The specified account has reached its limit of Amazon S3 buckets. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.CreateStorageLocation(Amazon.ElasticBeanstalk.Model.CreateStorageLocationRequest)"> <summary> Creates the Amazon S3 storage location for the account. <para> This location is used to store user log files. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateStorageLocation service method.</param> <returns>The response from the CreateStorageLocation service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.S3SubscriptionRequiredException"> The specified account does not have a subscription to Amazon S3. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyBucketsException"> The specified account has reached its limit of Amazon S3 buckets. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.CreateStorageLocationAsync(Amazon.ElasticBeanstalk.Model.CreateStorageLocationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateStorageLocation operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateStorageLocation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DeleteApplication(Amazon.ElasticBeanstalk.Model.DeleteApplicationRequest)"> <summary> Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket. <note>You cannot delete an application that has a running environment. </note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplication service method.</param> <returns>The response from the DeleteApplication service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.OperationInProgressException"> Unable to perform the specified operation because another operation that effects an element in this activity is already in progress. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DeleteApplicationAsync(Amazon.ElasticBeanstalk.Model.DeleteApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DeleteApplicationVersion(Amazon.ElasticBeanstalk.Model.DeleteApplicationVersionRequest)"> <summary> Deletes the specified version from the specified application. <note>You cannot delete an application version that is associated with a running environment.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplicationVersion service method.</param> <returns>The response from the DeleteApplicationVersion service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.OperationInProgressException"> Unable to perform the specified operation because another operation that effects an element in this activity is already in progress. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.S3LocationNotInServiceRegionException"> The specified S3 bucket does not belong to the S3 region in which the service is running. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.SourceBundleDeletionException"> Unable to delete the Amazon S3 source bundle associated with the application version. The application version was deleted successfully. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DeleteApplicationVersionAsync(Amazon.ElasticBeanstalk.Model.DeleteApplicationVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteApplicationVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplicationVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DeleteConfigurationTemplate(Amazon.ElasticBeanstalk.Model.DeleteConfigurationTemplateRequest)"> <summary> Deletes the specified configuration template. <note>When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteConfigurationTemplate service method.</param> <returns>The response from the DeleteConfigurationTemplate service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.OperationInProgressException"> Unable to perform the specified operation because another operation that effects an element in this activity is already in progress. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DeleteConfigurationTemplateAsync(Amazon.ElasticBeanstalk.Model.DeleteConfigurationTemplateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteConfigurationTemplate operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteConfigurationTemplate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DeleteEnvironmentConfiguration(Amazon.ElasticBeanstalk.Model.DeleteEnvironmentConfigurationRequest)"> <summary> Deletes the draft configuration associated with the running environment. <para> Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using <a>DescribeConfigurationSettings</a> while the update is in progress or if the update fails. The <code>DeploymentStatus</code> for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteEnvironmentConfiguration service method.</param> <returns>The response from the DeleteEnvironmentConfiguration service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DeleteEnvironmentConfigurationAsync(Amazon.ElasticBeanstalk.Model.DeleteEnvironmentConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteEnvironmentConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEnvironmentConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeApplications"> <summary> Returns the descriptions of existing applications. </summary> <returns>The response from the DescribeApplications service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeApplications(Amazon.ElasticBeanstalk.Model.DescribeApplicationsRequest)"> <summary> Returns the descriptions of existing applications. </summary> <param name="request">Container for the necessary parameters to execute the DescribeApplications service method.</param> <returns>The response from the DescribeApplications service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeApplicationsAsync(Amazon.ElasticBeanstalk.Model.DescribeApplicationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeApplications operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeApplications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeApplicationVersions"> <summary> Retrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket. </summary> <returns>The response from the DescribeApplicationVersions service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeApplicationVersions(Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsRequest)"> <summary> Retrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket. </summary> <param name="request">Container for the necessary parameters to execute the DescribeApplicationVersions service method.</param> <returns>The response from the DescribeApplicationVersions service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeApplicationVersionsAsync(Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeApplicationVersions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeApplicationVersions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeConfigurationOptions"> <summary> Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed. </summary> <returns>The response from the DescribeConfigurationOptions service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeConfigurationOptions(Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest)"> <summary> Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationOptions service method.</param> <returns>The response from the DescribeConfigurationOptions service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeConfigurationOptionsAsync(Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConfigurationOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeConfigurationSettings(Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsRequest)"> <summary> Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment. <para> When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy. </para> <para> Related Topics </para> <ul> <li> <a>DeleteEnvironmentConfiguration</a> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationSettings service method.</param> <returns>The response from the DescribeConfigurationSettings service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeConfigurationSettingsAsync(Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConfigurationSettings operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationSettings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeEnvironmentHealth(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentHealthRequest)"> <summary> Returns information about the overall health of the specified environment. The <b>DescribeEnvironmentHealth</b> operation is only available with AWS Elastic Beanstalk Enhanced Health. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEnvironmentHealth service method.</param> <returns>The response from the DescribeEnvironmentHealth service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.ElasticBeanstalkServiceException"> A generic service exception has occurred. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.InvalidRequestException"> One or more input parameters is not valid. Please correct the input parameters and try the operation again. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeEnvironmentHealthAsync(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentHealthRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEnvironmentHealth operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEnvironmentHealth operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeEnvironmentResources(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentResourcesRequest)"> <summary> Returns AWS resources for this environment. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEnvironmentResources service method.</param> <returns>The response from the DescribeEnvironmentResources service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeEnvironmentResourcesAsync(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentResourcesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEnvironmentResources operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEnvironmentResources operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeEnvironments"> <summary> Returns descriptions for existing environments. </summary> <returns>The response from the DescribeEnvironments service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeEnvironments(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest)"> <summary> Returns descriptions for existing environments. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEnvironments service method.</param> <returns>The response from the DescribeEnvironments service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeEnvironmentsAsync(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEnvironments operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEnvironments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeEvents"> <summary> Returns list of event descriptions matching criteria up to the last 6 weeks. <note> This action returns the most recent 1,000 events from the specified <code>NextToken</code>. </note> </summary> <returns>The response from the DescribeEvents service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeEvents(Amazon.ElasticBeanstalk.Model.DescribeEventsRequest)"> <summary> Returns list of event descriptions matching criteria up to the last 6 weeks. <note> This action returns the most recent 1,000 events from the specified <code>NextToken</code>. </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents service method.</param> <returns>The response from the DescribeEvents service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeEventsAsync(Amazon.ElasticBeanstalk.Model.DescribeEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeInstancesHealth(Amazon.ElasticBeanstalk.Model.DescribeInstancesHealthRequest)"> <summary> Returns more detailed information about the health of the specified instances (for example, CPU utilization, load average, and causes). The <b>DescribeInstancesHealth</b> operation is only available with AWS Elastic Beanstalk Enhanced Health. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstancesHealth service method.</param> <returns>The response from the DescribeInstancesHealth service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.ElasticBeanstalkServiceException"> A generic service exception has occurred. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.InvalidRequestException"> One or more input parameters is not valid. Please correct the input parameters and try the operation again. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.DescribeInstancesHealthAsync(Amazon.ElasticBeanstalk.Model.DescribeInstancesHealthRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInstancesHealth operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstancesHealth operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.ListAvailableSolutionStacks"> <summary> Returns a list of the available solution stack names. </summary> <returns>The response from the ListAvailableSolutionStacks service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.ListAvailableSolutionStacks(Amazon.ElasticBeanstalk.Model.ListAvailableSolutionStacksRequest)"> <summary> Returns a list of the available solution stack names. </summary> <param name="request">Container for the necessary parameters to execute the ListAvailableSolutionStacks service method.</param> <returns>The response from the ListAvailableSolutionStacks service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.ListAvailableSolutionStacksAsync(Amazon.ElasticBeanstalk.Model.ListAvailableSolutionStacksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAvailableSolutionStacks operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAvailableSolutionStacks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.RebuildEnvironment(Amazon.ElasticBeanstalk.Model.RebuildEnvironmentRequest)"> <summary> Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart. </summary> <param name="request">Container for the necessary parameters to execute the RebuildEnvironment service method.</param> <returns>The response from the RebuildEnvironment service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.RebuildEnvironmentAsync(Amazon.ElasticBeanstalk.Model.RebuildEnvironmentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RebuildEnvironment operation. </summary> <param name="request">Container for the necessary parameters to execute the RebuildEnvironment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.RequestEnvironmentInfo(Amazon.ElasticBeanstalk.Model.RequestEnvironmentInfoRequest)"> <summary> Initiates a request to compile the specified type of information of the deployed environment. <para> Setting the <code>InfoType</code> to <code>tail</code> compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. </para> <para> Setting the <code>InfoType</code> to <code>bundle</code> compresses the application server log files for every Amazon EC2 instance into a <code>.zip</code> file. Legacy and .NET containers do not support bundle logs. </para> <para> Use <a>RetrieveEnvironmentInfo</a> to obtain the set of logs. </para> <para> Related Topics </para> <ul> <li> <a>RetrieveEnvironmentInfo</a> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the RequestEnvironmentInfo service method.</param> <returns>The response from the RequestEnvironmentInfo service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.RequestEnvironmentInfoAsync(Amazon.ElasticBeanstalk.Model.RequestEnvironmentInfoRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RequestEnvironmentInfo operation. </summary> <param name="request">Container for the necessary parameters to execute the RequestEnvironmentInfo operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.RestartAppServer(Amazon.ElasticBeanstalk.Model.RestartAppServerRequest)"> <summary> Causes the environment to restart the application container server running on each Amazon EC2 instance. </summary> <param name="request">Container for the necessary parameters to execute the RestartAppServer service method.</param> <returns>The response from the RestartAppServer service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.RestartAppServerAsync(Amazon.ElasticBeanstalk.Model.RestartAppServerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestartAppServer operation. </summary> <param name="request">Container for the necessary parameters to execute the RestartAppServer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.RetrieveEnvironmentInfo(Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoRequest)"> <summary> Retrieves the compiled information from a <a>RequestEnvironmentInfo</a> request. <para> Related Topics </para> <ul> <li> <a>RequestEnvironmentInfo</a> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the RetrieveEnvironmentInfo service method.</param> <returns>The response from the RetrieveEnvironmentInfo service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.RetrieveEnvironmentInfoAsync(Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RetrieveEnvironmentInfo operation. </summary> <param name="request">Container for the necessary parameters to execute the RetrieveEnvironmentInfo operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.SwapEnvironmentCNAMEs(Amazon.ElasticBeanstalk.Model.SwapEnvironmentCNAMEsRequest)"> <summary> Swaps the CNAMEs of two environments. </summary> <param name="request">Container for the necessary parameters to execute the SwapEnvironmentCNAMEs service method.</param> <returns>The response from the SwapEnvironmentCNAMEs service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.SwapEnvironmentCNAMEsAsync(Amazon.ElasticBeanstalk.Model.SwapEnvironmentCNAMEsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SwapEnvironmentCNAMEs operation. </summary> <param name="request">Container for the necessary parameters to execute the SwapEnvironmentCNAMEs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.TerminateEnvironment(Amazon.ElasticBeanstalk.Model.TerminateEnvironmentRequest)"> <summary> Terminates the specified environment. </summary> <param name="request">Container for the necessary parameters to execute the TerminateEnvironment service method.</param> <returns>The response from the TerminateEnvironment service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.TerminateEnvironmentAsync(Amazon.ElasticBeanstalk.Model.TerminateEnvironmentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TerminateEnvironment operation. </summary> <param name="request">Container for the necessary parameters to execute the TerminateEnvironment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.UpdateApplication(Amazon.ElasticBeanstalk.Model.UpdateApplicationRequest)"> <summary> Updates the specified application to have the specified properties. <note> If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear these properties, specify an empty string. </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplication service method.</param> <returns>The response from the UpdateApplication service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.UpdateApplicationAsync(Amazon.ElasticBeanstalk.Model.UpdateApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.UpdateApplicationVersion(Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionRequest)"> <summary> Updates the specified application version to have the specified properties. <note> If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear properties, specify an empty string. </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplicationVersion service method.</param> <returns>The response from the UpdateApplicationVersion service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.UpdateApplicationVersionAsync(Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateApplicationVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplicationVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.UpdateConfigurationTemplate(Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest)"> <summary> Updates the specified configuration template to have the specified properties or configuration option values. <note> If a property (for example, <code>ApplicationName</code>) is not provided, its value remains unchanged. To clear such properties, specify an empty string. </note> <para> Related Topics </para> <ul> <li> <a>DescribeConfigurationOptions</a> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the UpdateConfigurationTemplate service method.</param> <returns>The response from the UpdateConfigurationTemplate service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.UpdateConfigurationTemplateAsync(Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateConfigurationTemplate operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateConfigurationTemplate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.UpdateEnvironment(Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest)"> <summary> Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment. <para> Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. </para> <para> When updating the configuration settings to a new template or individual settings, a draft configuration is created and <a>DescribeConfigurationSettings</a> for this environment returns two setting descriptions with different <code>DeploymentStatus</code> values. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateEnvironment service method.</param> <returns>The response from the UpdateEnvironment service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.UpdateEnvironmentAsync(Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateEnvironment operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateEnvironment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.ValidateConfigurationSettings(Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest)"> <summary> Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid. <para> This action returns a list of messages indicating any errors or warnings associated with the selection of option values. </para> </summary> <param name="request">Container for the necessary parameters to execute the ValidateConfigurationSettings service method.</param> <returns>The response from the ValidateConfigurationSettings service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk.ValidateConfigurationSettingsAsync(Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ValidateConfigurationSettings operation. </summary> <param name="request">Container for the necessary parameters to execute the ValidateConfigurationSettings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.#ctor"> <summary> Constructs AmazonElasticBeanstalkClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticBeanstalkClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.#ctor(Amazon.ElasticBeanstalk.AmazonElasticBeanstalkConfig)"> <summary> Constructs AmazonElasticBeanstalkClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonElasticBeanstalkClient Configuration Object</param> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonElasticBeanstalkClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticBeanstalkClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.ElasticBeanstalk.AmazonElasticBeanstalkConfig)"> <summary> Constructs AmazonElasticBeanstalkClient with AWS Credentials and an AmazonElasticBeanstalkClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonElasticBeanstalkClient Configuration Object</param> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonElasticBeanstalkClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticBeanstalkClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.#ctor(System.String,System.String,Amazon.ElasticBeanstalk.AmazonElasticBeanstalkConfig)"> <summary> Constructs AmazonElasticBeanstalkClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticBeanstalkClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonElasticBeanstalkClient Configuration Object</param> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonElasticBeanstalkClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticBeanstalkClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.#ctor(System.String,System.String,System.String,Amazon.ElasticBeanstalk.AmazonElasticBeanstalkConfig)"> <summary> Constructs AmazonElasticBeanstalkClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticBeanstalkClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonElasticBeanstalkClient Configuration Object</param> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.AbortEnvironmentUpdate(Amazon.ElasticBeanstalk.Model.AbortEnvironmentUpdateRequest)"> <summary> Cancels in-progress environment configuration update or application version deployment. </summary> <param name="request">Container for the necessary parameters to execute the AbortEnvironmentUpdate service method.</param> <returns>The response from the AbortEnvironmentUpdate service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.AbortEnvironmentUpdateAsync(Amazon.ElasticBeanstalk.Model.AbortEnvironmentUpdateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AbortEnvironmentUpdate operation. </summary> <param name="request">Container for the necessary parameters to execute the AbortEnvironmentUpdate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.CheckDNSAvailability(Amazon.ElasticBeanstalk.Model.CheckDNSAvailabilityRequest)"> <summary> Checks if the specified CNAME is available. </summary> <param name="request">Container for the necessary parameters to execute the CheckDNSAvailability service method.</param> <returns>The response from the CheckDNSAvailability service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.CheckDNSAvailabilityAsync(Amazon.ElasticBeanstalk.Model.CheckDNSAvailabilityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CheckDNSAvailability operation. </summary> <param name="request">Container for the necessary parameters to execute the CheckDNSAvailability operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.ComposeEnvironments(Amazon.ElasticBeanstalk.Model.ComposeEnvironmentsRequest)"> <summary> Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named <code>env.yaml</code>. See <a href="http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-mgmt-compose.html">Compose Environments</a> for details. </summary> <param name="request">Container for the necessary parameters to execute the ComposeEnvironments service method.</param> <returns>The response from the ComposeEnvironments service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyEnvironmentsException"> The specified account has reached its limit of environments. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.ComposeEnvironmentsAsync(Amazon.ElasticBeanstalk.Model.ComposeEnvironmentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ComposeEnvironments operation. </summary> <param name="request">Container for the necessary parameters to execute the ComposeEnvironments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.CreateApplication(Amazon.ElasticBeanstalk.Model.CreateApplicationRequest)"> <summary> Creates an application that has one configuration template named <code>default</code> and no application versions. </summary> <param name="request">Container for the necessary parameters to execute the CreateApplication service method.</param> <returns>The response from the CreateApplication service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyApplicationsException"> The specified account has reached its limit of applications. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.CreateApplicationAsync(Amazon.ElasticBeanstalk.Model.CreateApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.CreateApplicationVersion(Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest)"> <summary> Creates an application version for the specified application. <note>Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version. </note> </summary> <param name="request">Container for the necessary parameters to execute the CreateApplicationVersion service method.</param> <returns>The response from the CreateApplicationVersion service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.S3LocationNotInServiceRegionException"> The specified S3 bucket does not belong to the S3 region in which the service is running. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyApplicationsException"> The specified account has reached its limit of applications. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyApplicationVersionsException"> The specified account has reached its limit of application versions. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.CreateApplicationVersionAsync(Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateApplicationVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateApplicationVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.CreateConfigurationTemplate(Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest)"> <summary> Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings. <para> Related Topics </para> <ul> <li> <a>DescribeConfigurationOptions</a> </li> <li> <a>DescribeConfigurationSettings</a> </li> <li> <a>ListAvailableSolutionStacks</a> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the CreateConfigurationTemplate service method.</param> <returns>The response from the CreateConfigurationTemplate service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyConfigurationTemplatesException"> The specified account has reached its limit of configuration templates. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.CreateConfigurationTemplateAsync(Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateConfigurationTemplate operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateConfigurationTemplate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.CreateEnvironment(Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest)"> <summary> Launches an environment for the specified application using the specified configuration. </summary> <param name="request">Container for the necessary parameters to execute the CreateEnvironment service method.</param> <returns>The response from the CreateEnvironment service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyEnvironmentsException"> The specified account has reached its limit of environments. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.CreateEnvironmentAsync(Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateEnvironment operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateEnvironment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.CreateStorageLocation"> <summary> Creates the Amazon S3 storage location for the account. <para> This location is used to store user log files. </para> </summary> <returns>The response from the CreateStorageLocation service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.S3SubscriptionRequiredException"> The specified account does not have a subscription to Amazon S3. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyBucketsException"> The specified account has reached its limit of Amazon S3 buckets. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.CreateStorageLocation(Amazon.ElasticBeanstalk.Model.CreateStorageLocationRequest)"> <summary> Creates the Amazon S3 storage location for the account. <para> This location is used to store user log files. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateStorageLocation service method.</param> <returns>The response from the CreateStorageLocation service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.S3SubscriptionRequiredException"> The specified account does not have a subscription to Amazon S3. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyBucketsException"> The specified account has reached its limit of Amazon S3 buckets. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.CreateStorageLocationAsync(Amazon.ElasticBeanstalk.Model.CreateStorageLocationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateStorageLocation operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateStorageLocation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DeleteApplication(Amazon.ElasticBeanstalk.Model.DeleteApplicationRequest)"> <summary> Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket. <note>You cannot delete an application that has a running environment. </note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplication service method.</param> <returns>The response from the DeleteApplication service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.OperationInProgressException"> Unable to perform the specified operation because another operation that effects an element in this activity is already in progress. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DeleteApplicationAsync(Amazon.ElasticBeanstalk.Model.DeleteApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DeleteApplicationVersion(Amazon.ElasticBeanstalk.Model.DeleteApplicationVersionRequest)"> <summary> Deletes the specified version from the specified application. <note>You cannot delete an application version that is associated with a running environment.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplicationVersion service method.</param> <returns>The response from the DeleteApplicationVersion service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.OperationInProgressException"> Unable to perform the specified operation because another operation that effects an element in this activity is already in progress. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.S3LocationNotInServiceRegionException"> The specified S3 bucket does not belong to the S3 region in which the service is running. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.SourceBundleDeletionException"> Unable to delete the Amazon S3 source bundle associated with the application version. The application version was deleted successfully. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DeleteApplicationVersionAsync(Amazon.ElasticBeanstalk.Model.DeleteApplicationVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteApplicationVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplicationVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DeleteConfigurationTemplate(Amazon.ElasticBeanstalk.Model.DeleteConfigurationTemplateRequest)"> <summary> Deletes the specified configuration template. <note>When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteConfigurationTemplate service method.</param> <returns>The response from the DeleteConfigurationTemplate service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.OperationInProgressException"> Unable to perform the specified operation because another operation that effects an element in this activity is already in progress. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DeleteConfigurationTemplateAsync(Amazon.ElasticBeanstalk.Model.DeleteConfigurationTemplateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteConfigurationTemplate operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteConfigurationTemplate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DeleteEnvironmentConfiguration(Amazon.ElasticBeanstalk.Model.DeleteEnvironmentConfigurationRequest)"> <summary> Deletes the draft configuration associated with the running environment. <para> Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using <a>DescribeConfigurationSettings</a> while the update is in progress or if the update fails. The <code>DeploymentStatus</code> for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteEnvironmentConfiguration service method.</param> <returns>The response from the DeleteEnvironmentConfiguration service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DeleteEnvironmentConfigurationAsync(Amazon.ElasticBeanstalk.Model.DeleteEnvironmentConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteEnvironmentConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEnvironmentConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeApplications"> <summary> Returns the descriptions of existing applications. </summary> <returns>The response from the DescribeApplications service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeApplications(Amazon.ElasticBeanstalk.Model.DescribeApplicationsRequest)"> <summary> Returns the descriptions of existing applications. </summary> <param name="request">Container for the necessary parameters to execute the DescribeApplications service method.</param> <returns>The response from the DescribeApplications service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeApplicationsAsync(Amazon.ElasticBeanstalk.Model.DescribeApplicationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeApplications operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeApplications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeApplicationVersions"> <summary> Retrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket. </summary> <returns>The response from the DescribeApplicationVersions service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeApplicationVersions(Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsRequest)"> <summary> Retrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket. </summary> <param name="request">Container for the necessary parameters to execute the DescribeApplicationVersions service method.</param> <returns>The response from the DescribeApplicationVersions service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeApplicationVersionsAsync(Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeApplicationVersions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeApplicationVersions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeConfigurationOptions"> <summary> Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed. </summary> <returns>The response from the DescribeConfigurationOptions service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeConfigurationOptions(Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest)"> <summary> Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationOptions service method.</param> <returns>The response from the DescribeConfigurationOptions service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeConfigurationOptionsAsync(Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConfigurationOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeConfigurationSettings(Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsRequest)"> <summary> Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment. <para> When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy. </para> <para> Related Topics </para> <ul> <li> <a>DeleteEnvironmentConfiguration</a> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationSettings service method.</param> <returns>The response from the DescribeConfigurationSettings service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeConfigurationSettingsAsync(Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeConfigurationSettings operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationSettings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeEnvironmentHealth(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentHealthRequest)"> <summary> Returns information about the overall health of the specified environment. The <b>DescribeEnvironmentHealth</b> operation is only available with AWS Elastic Beanstalk Enhanced Health. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEnvironmentHealth service method.</param> <returns>The response from the DescribeEnvironmentHealth service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.ElasticBeanstalkServiceException"> A generic service exception has occurred. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.InvalidRequestException"> One or more input parameters is not valid. Please correct the input parameters and try the operation again. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeEnvironmentHealthAsync(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentHealthRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEnvironmentHealth operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEnvironmentHealth operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeEnvironmentResources(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentResourcesRequest)"> <summary> Returns AWS resources for this environment. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEnvironmentResources service method.</param> <returns>The response from the DescribeEnvironmentResources service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeEnvironmentResourcesAsync(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentResourcesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEnvironmentResources operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEnvironmentResources operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeEnvironments"> <summary> Returns descriptions for existing environments. </summary> <returns>The response from the DescribeEnvironments service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeEnvironments(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest)"> <summary> Returns descriptions for existing environments. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEnvironments service method.</param> <returns>The response from the DescribeEnvironments service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeEnvironmentsAsync(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEnvironments operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEnvironments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeEvents"> <summary> Returns list of event descriptions matching criteria up to the last 6 weeks. <note> This action returns the most recent 1,000 events from the specified <code>NextToken</code>. </note> </summary> <returns>The response from the DescribeEvents service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeEvents(Amazon.ElasticBeanstalk.Model.DescribeEventsRequest)"> <summary> Returns list of event descriptions matching criteria up to the last 6 weeks. <note> This action returns the most recent 1,000 events from the specified <code>NextToken</code>. </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents service method.</param> <returns>The response from the DescribeEvents service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeEventsAsync(Amazon.ElasticBeanstalk.Model.DescribeEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeInstancesHealth(Amazon.ElasticBeanstalk.Model.DescribeInstancesHealthRequest)"> <summary> Returns more detailed information about the health of the specified instances (for example, CPU utilization, load average, and causes). The <b>DescribeInstancesHealth</b> operation is only available with AWS Elastic Beanstalk Enhanced Health. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstancesHealth service method.</param> <returns>The response from the DescribeInstancesHealth service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.ElasticBeanstalkServiceException"> A generic service exception has occurred. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.InvalidRequestException"> One or more input parameters is not valid. Please correct the input parameters and try the operation again. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeInstancesHealthAsync(Amazon.ElasticBeanstalk.Model.DescribeInstancesHealthRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInstancesHealth operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstancesHealth operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.ListAvailableSolutionStacks"> <summary> Returns a list of the available solution stack names. </summary> <returns>The response from the ListAvailableSolutionStacks service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.ListAvailableSolutionStacks(Amazon.ElasticBeanstalk.Model.ListAvailableSolutionStacksRequest)"> <summary> Returns a list of the available solution stack names. </summary> <param name="request">Container for the necessary parameters to execute the ListAvailableSolutionStacks service method.</param> <returns>The response from the ListAvailableSolutionStacks service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.ListAvailableSolutionStacksAsync(Amazon.ElasticBeanstalk.Model.ListAvailableSolutionStacksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAvailableSolutionStacks operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAvailableSolutionStacks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.RebuildEnvironment(Amazon.ElasticBeanstalk.Model.RebuildEnvironmentRequest)"> <summary> Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart. </summary> <param name="request">Container for the necessary parameters to execute the RebuildEnvironment service method.</param> <returns>The response from the RebuildEnvironment service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.RebuildEnvironmentAsync(Amazon.ElasticBeanstalk.Model.RebuildEnvironmentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RebuildEnvironment operation. </summary> <param name="request">Container for the necessary parameters to execute the RebuildEnvironment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.RequestEnvironmentInfo(Amazon.ElasticBeanstalk.Model.RequestEnvironmentInfoRequest)"> <summary> Initiates a request to compile the specified type of information of the deployed environment. <para> Setting the <code>InfoType</code> to <code>tail</code> compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. </para> <para> Setting the <code>InfoType</code> to <code>bundle</code> compresses the application server log files for every Amazon EC2 instance into a <code>.zip</code> file. Legacy and .NET containers do not support bundle logs. </para> <para> Use <a>RetrieveEnvironmentInfo</a> to obtain the set of logs. </para> <para> Related Topics </para> <ul> <li> <a>RetrieveEnvironmentInfo</a> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the RequestEnvironmentInfo service method.</param> <returns>The response from the RequestEnvironmentInfo service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.RequestEnvironmentInfoAsync(Amazon.ElasticBeanstalk.Model.RequestEnvironmentInfoRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RequestEnvironmentInfo operation. </summary> <param name="request">Container for the necessary parameters to execute the RequestEnvironmentInfo operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.RestartAppServer(Amazon.ElasticBeanstalk.Model.RestartAppServerRequest)"> <summary> Causes the environment to restart the application container server running on each Amazon EC2 instance. </summary> <param name="request">Container for the necessary parameters to execute the RestartAppServer service method.</param> <returns>The response from the RestartAppServer service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.RestartAppServerAsync(Amazon.ElasticBeanstalk.Model.RestartAppServerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestartAppServer operation. </summary> <param name="request">Container for the necessary parameters to execute the RestartAppServer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.RetrieveEnvironmentInfo(Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoRequest)"> <summary> Retrieves the compiled information from a <a>RequestEnvironmentInfo</a> request. <para> Related Topics </para> <ul> <li> <a>RequestEnvironmentInfo</a> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the RetrieveEnvironmentInfo service method.</param> <returns>The response from the RetrieveEnvironmentInfo service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.RetrieveEnvironmentInfoAsync(Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RetrieveEnvironmentInfo operation. </summary> <param name="request">Container for the necessary parameters to execute the RetrieveEnvironmentInfo operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.SwapEnvironmentCNAMEs(Amazon.ElasticBeanstalk.Model.SwapEnvironmentCNAMEsRequest)"> <summary> Swaps the CNAMEs of two environments. </summary> <param name="request">Container for the necessary parameters to execute the SwapEnvironmentCNAMEs service method.</param> <returns>The response from the SwapEnvironmentCNAMEs service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.SwapEnvironmentCNAMEsAsync(Amazon.ElasticBeanstalk.Model.SwapEnvironmentCNAMEsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SwapEnvironmentCNAMEs operation. </summary> <param name="request">Container for the necessary parameters to execute the SwapEnvironmentCNAMEs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.TerminateEnvironment(Amazon.ElasticBeanstalk.Model.TerminateEnvironmentRequest)"> <summary> Terminates the specified environment. </summary> <param name="request">Container for the necessary parameters to execute the TerminateEnvironment service method.</param> <returns>The response from the TerminateEnvironment service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.TerminateEnvironmentAsync(Amazon.ElasticBeanstalk.Model.TerminateEnvironmentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TerminateEnvironment operation. </summary> <param name="request">Container for the necessary parameters to execute the TerminateEnvironment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.UpdateApplication(Amazon.ElasticBeanstalk.Model.UpdateApplicationRequest)"> <summary> Updates the specified application to have the specified properties. <note> If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear these properties, specify an empty string. </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplication service method.</param> <returns>The response from the UpdateApplication service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.UpdateApplicationAsync(Amazon.ElasticBeanstalk.Model.UpdateApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.UpdateApplicationVersion(Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionRequest)"> <summary> Updates the specified application version to have the specified properties. <note> If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear properties, specify an empty string. </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplicationVersion service method.</param> <returns>The response from the UpdateApplicationVersion service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.UpdateApplicationVersionAsync(Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateApplicationVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplicationVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.UpdateConfigurationTemplate(Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest)"> <summary> Updates the specified configuration template to have the specified properties or configuration option values. <note> If a property (for example, <code>ApplicationName</code>) is not provided, its value remains unchanged. To clear such properties, specify an empty string. </note> <para> Related Topics </para> <ul> <li> <a>DescribeConfigurationOptions</a> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the UpdateConfigurationTemplate service method.</param> <returns>The response from the UpdateConfigurationTemplate service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.UpdateConfigurationTemplateAsync(Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateConfigurationTemplate operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateConfigurationTemplate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.UpdateEnvironment(Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest)"> <summary> Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment. <para> Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. </para> <para> When updating the configuration settings to a new template or individual settings, a draft configuration is created and <a>DescribeConfigurationSettings</a> for this environment returns two setting descriptions with different <code>DeploymentStatus</code> values. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateEnvironment service method.</param> <returns>The response from the UpdateEnvironment service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.UpdateEnvironmentAsync(Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateEnvironment operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateEnvironment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.ValidateConfigurationSettings(Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest)"> <summary> Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid. <para> This action returns a list of messages indicating any errors or warnings associated with the selection of option values. </para> </summary> <param name="request">Container for the necessary parameters to execute the ValidateConfigurationSettings service method.</param> <returns>The response from the ValidateConfigurationSettings service method, as returned by ElasticBeanstalk.</returns> <exception cref="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> The specified account does not have sufficient privileges for one of more AWS services. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.ValidateConfigurationSettingsAsync(Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ValidateConfigurationSettings operation. </summary> <param name="request">Container for the necessary parameters to execute the ValidateConfigurationSettings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient"> <summary> Implementation for accessing ElasticFileSystem Amazon Elastic File System </summary> </member> <member name="T:Amazon.ElasticFileSystem.IAmazonElasticFileSystem"> <summary> Interface for accessing ElasticFileSystem Amazon Elastic File System </summary> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.CreateFileSystem(System.String)"> <summary> Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following: <ul> <li>Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state "creating". </li> <li> Returns with the description of the created file system. </li> </ul> <para> Otherwise, this operation returns a <code>FileSystemAlreadyExists</code> error with the ID of the existing file system. </para> <note>For basic use cases, you can use a randomly generated UUID for the creation token.</note> <para> The idempotent operation allows you to retry a <code>CreateFileSystem</code> call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the <code>FileSystemAlreadyExists</code> error. </para> <note>The <code>CreateFileSystem</code> call returns while the file system's lifecycle state is still "creating". You can check the file system creation status by calling the <a>DescribeFileSystems</a> API, which among other things returns the file system state.</note> <para> After the file system is fully created, Amazon EFS sets its lifecycle state to "available", at which point you can create one or more mount targets for the file system (<a>CreateMountTarget</a>) in your VPC. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see <a href="http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html">Amazon EFS: How it Works</a> </para> <para> This operation requires permission for the <code>elasticfilesystem:CreateFileSystem</code> action. </para> </summary> <param name="creationToken">String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.</param> <returns>The response from the CreateFileSystem service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemAlreadyExistsException"> Returned if the file system you are trying to create already exists, with the creation token you provided. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemLimitExceededException"> Returned if the AWS account has already created maximum number of file systems allowed per account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.CreateFileSystem(Amazon.ElasticFileSystem.Model.CreateFileSystemRequest)"> <summary> Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following: <ul> <li>Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state "creating". </li> <li> Returns with the description of the created file system. </li> </ul> <para> Otherwise, this operation returns a <code>FileSystemAlreadyExists</code> error with the ID of the existing file system. </para> <note>For basic use cases, you can use a randomly generated UUID for the creation token.</note> <para> The idempotent operation allows you to retry a <code>CreateFileSystem</code> call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the <code>FileSystemAlreadyExists</code> error. </para> <note>The <code>CreateFileSystem</code> call returns while the file system's lifecycle state is still "creating". You can check the file system creation status by calling the <a>DescribeFileSystems</a> API, which among other things returns the file system state.</note> <para> After the file system is fully created, Amazon EFS sets its lifecycle state to "available", at which point you can create one or more mount targets for the file system (<a>CreateMountTarget</a>) in your VPC. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see <a href="http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html">Amazon EFS: How it Works</a> </para> <para> This operation requires permission for the <code>elasticfilesystem:CreateFileSystem</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateFileSystem service method.</param> <returns>The response from the CreateFileSystem service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemAlreadyExistsException"> Returned if the file system you are trying to create already exists, with the creation token you provided. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemLimitExceededException"> Returned if the AWS account has already created maximum number of file systems allowed per account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.CreateFileSystemAsync(Amazon.ElasticFileSystem.Model.CreateFileSystemRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateFileSystem operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateFileSystem operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.CreateMountTarget(Amazon.ElasticFileSystem.Model.CreateMountTargetRequest)"> <summary> Creates a mount target for a file system. You can then mount the file system on EC2 instances via the mount target. <para> You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see <a href="http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html">Amazon EFS: How it Works</a>. </para> <para> In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be "available" (see <a>DescribeFileSystems</a>). </para> <para> In the request, you also provide a subnet ID, which serves several purposes: </para> <ul> <li>It determines the VPC in which Amazon EFS creates the mount target.</li> <li>It determines the Availability Zone in which Amazon EFS creates the mount target. </li> <li>It determines the IP address range from which Amazon EFS selects the IP address of the mount target if you don't specify an IP address in the request. </li> </ul> <para> After creating the mount target, Amazon EFS returns a response that includes, a <code>MountTargetId</code> and an <code>IpAddress</code>. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system via the mount target can resolve the mount target's DNS name to its IP address. For more information, see <a href="http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation">How it Works: Implementation Overview</a> </para> <para> Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the request to add another mount target must meet the following requirements: </para> <ul> <li> <para> The subnet specified in the request must belong to the same VPC as the subnets of the existing mount targets. </para> </li> <li>The subnet specified in the request must not be in the same Availability Zone as any of the subnets of the existing mount targets.</li> </ul> <para> If the request satisfies the requirements, Amazon EFS does the following: </para> <ul> <li>Creates a new mount target in the specified subnet. </li> <li>Also creates a new network interface in the subnet as follows: <ul> <li>If the request provides an <code>IpAddress</code>, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 <code>CreateNetworkInterface</code> call does when a request does not specify a primary private IP address).</li> <li>If the request provides <code>SecurityGroups</code>, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.</li> <li>Assigns the description <code>"Mount target <i>fsmt-id</i> for file system <i>fs-id</i>"</code> where <code><i>fsmt-id</i></code> is the mount target ID, and <code><i>fs-id</i></code> is the <code>FileSystemId</code>.</li> <li>Sets the <code>requesterManaged</code> property of the network interface to "true", and the <code>requesterId</code> value to "EFS".</li> </ul> <para> Each Amazon EFS mount target has one corresponding requestor-managed EC2 network interface. After the network interface is created, Amazon EFS sets the <code>NetworkInterfaceId</code> field in the mount target's description to the network interface ID, and the <code>IpAddress</code> field to its address. If network interface creation fails, the entire <code>CreateMountTarget</code> operation fails. </para> </li> </ul> <note>The <code>CreateMountTarget</code> call returns only after creating the network interface, but while the mount target state is still "creating". You can check the mount target creation status by calling the <a>DescribeFileSystems</a> API, which among other things returns the mount target state.</note> <para> We recommend you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, go to <a href="http://aws.amazon.com/efs/">Amazon EFS</a> product detail page. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario; if the Availablity Zone in which your mount target is created goes down, then you won't be able to access your file system through that mount target. </para> <para> This operation requires permission for the following action on the file system: </para> <ul> <li><code>elasticfilesystem:CreateMountTarget</code></li> </ul> <para> This operation also requires permission for the following Amazon EC2 actions: </para> <ul> <li><code>ec2:DescribeSubnets</code></li> <li><code>ec2:DescribeNetworkInterfaces</code></li> <li><code>ec2:CreateNetworkInterface</code></li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the CreateMountTarget service method.</param> <returns>The response from the CreateMountTarget service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.IncorrectFileSystemLifeCycleStateException"> Returned if the file system's life cycle state is not "created". </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.IpAddressInUseException"> Returned if the request specified an <code>IpAddress</code> that is already in use in the subnet. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.MountTargetConflictException"> Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.NetworkInterfaceLimitExceededException"> The calling account has reached the ENI limit for the specific AWS region. Client should try to delete some ENIs or get its account limit raised. For more information, go to <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html">Amazon VPC Limits</a> in the Amazon Virtual Private Cloud User Guide (see the Network interfaces per VPC entry in the table). </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.NoFreeAddressesInSubnetException"> Returned if <code>IpAddress</code> was not specified in the request and there are no free IP addresses in the subnet. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.SecurityGroupLimitExceededException"> Returned if the size of <code>SecurityGroups</code> specified in the request is greater than five. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.SecurityGroupNotFoundException"> Returned if one of the specified security groups does not exist in the subnet's VPC. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.SubnetNotFoundException"> Returned if there is no subnet with ID <code>SubnetId</code> provided in the request. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.UnsupportedAvailabilityZoneException"> </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.CreateMountTargetAsync(Amazon.ElasticFileSystem.Model.CreateMountTargetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateMountTarget operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateMountTarget operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.CreateTags(Amazon.ElasticFileSystem.Model.CreateTagsRequest)"> <summary> Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the "Name" tag to your file system, Amazon EFS returns it in the response to the <a>DescribeFileSystems</a> API. <para> This operation requires permission for the <code>elasticfilesystem:CreateTags</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateTags service method.</param> <returns>The response from the CreateTags service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.CreateTagsAsync(Amazon.ElasticFileSystem.Model.CreateTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTags operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DeleteFileSystem(System.String)"> <summary> Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you will not be able to access any contents of the deleted file system. <para> You cannot delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see <a>DescribeMountTargets</a> and <a>DeleteMountTarget</a>. </para> <note>The <code>DeleteFileSystem</code> call returns while the file system state is still "deleting". You can check the file system deletion status by calling the <a>DescribeFileSystems</a> API, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the <a>DescribeFileSystems</a> will return a 404 "FileSystemNotFound" error.</note> <para> This operation requires permission for the <code>elasticfilesystem:DeleteFileSystem</code> action. </para> </summary> <param name="fileSystemId">The ID of the file system you want to delete.</param> <returns>The response from the DeleteFileSystem service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemInUseException"> Returned if a file system has mount targets. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DeleteFileSystem(Amazon.ElasticFileSystem.Model.DeleteFileSystemRequest)"> <summary> Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you will not be able to access any contents of the deleted file system. <para> You cannot delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see <a>DescribeMountTargets</a> and <a>DeleteMountTarget</a>. </para> <note>The <code>DeleteFileSystem</code> call returns while the file system state is still "deleting". You can check the file system deletion status by calling the <a>DescribeFileSystems</a> API, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the <a>DescribeFileSystems</a> will return a 404 "FileSystemNotFound" error.</note> <para> This operation requires permission for the <code>elasticfilesystem:DeleteFileSystem</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteFileSystem service method.</param> <returns>The response from the DeleteFileSystem service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemInUseException"> Returned if a file system has mount targets. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DeleteFileSystemAsync(Amazon.ElasticFileSystem.Model.DeleteFileSystemRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteFileSystem operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteFileSystem operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DeleteMountTarget(System.String)"> <summary> Deletes the specified mount target. <para> This operation forcibly breaks any mounts of the file system via the mount target being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC using another mount target. </para> <para> This operation requires permission for the following action on the file system: </para> <ul> <li><code>elasticfilesystem:DeleteMountTarget</code></li> </ul> <note>The <code>DeleteMountTarget</code> call returns while the mount target state is still "deleting". You can check the mount target deletion by calling the <a>DescribeMountTargets</a> API, which returns a list of mount target descriptions for the given file system. </note> <para> The operation also requires permission for the following Amazon EC2 action on the mount target's network interface: </para> <ul> <li><code>ec2:DeleteNetworkInterface</code></li> </ul> </summary> <param name="mountTargetId">String. The ID of the mount target to delete.</param> <returns>The response from the DeleteMountTarget service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.DependencyTimeoutException"> The service timed out trying to fulfill the request, and the client should try the call again. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.MountTargetNotFoundException"> Returned if there is no mount target with the specified ID is found in the caller's account. </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DeleteMountTarget(Amazon.ElasticFileSystem.Model.DeleteMountTargetRequest)"> <summary> Deletes the specified mount target. <para> This operation forcibly breaks any mounts of the file system via the mount target being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC using another mount target. </para> <para> This operation requires permission for the following action on the file system: </para> <ul> <li><code>elasticfilesystem:DeleteMountTarget</code></li> </ul> <note>The <code>DeleteMountTarget</code> call returns while the mount target state is still "deleting". You can check the mount target deletion by calling the <a>DescribeMountTargets</a> API, which returns a list of mount target descriptions for the given file system. </note> <para> The operation also requires permission for the following Amazon EC2 action on the mount target's network interface: </para> <ul> <li><code>ec2:DeleteNetworkInterface</code></li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DeleteMountTarget service method.</param> <returns>The response from the DeleteMountTarget service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.DependencyTimeoutException"> The service timed out trying to fulfill the request, and the client should try the call again. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.MountTargetNotFoundException"> Returned if there is no mount target with the specified ID is found in the caller's account. </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DeleteMountTargetAsync(Amazon.ElasticFileSystem.Model.DeleteMountTargetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteMountTarget operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteMountTarget operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DeleteTags(Amazon.ElasticFileSystem.Model.DeleteTagsRequest)"> <summary> Deletes the specified tags from a file system. If the <code>DeleteTags</code> request includes a tag key that does not exist, Amazon EFS ignores it; it is not an error. For more information about tags and related restrictions, go to <a href="http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Tag Restrictions</a> in the <i>AWS Billing and Cost Management User Guide</i>. <para> This operation requires permission for the <code>elasticfilesystem:DeleteTags</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags service method.</param> <returns>The response from the DeleteTags service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DeleteTagsAsync(Amazon.ElasticFileSystem.Model.DeleteTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DescribeFileSystems(Amazon.ElasticFileSystem.Model.DescribeFileSystemsRequest)"> <summary> Returns the description of a specific Amazon EFS file system if either the file system <code>CreationToken</code> or the <code>FileSystemId</code> is provided; otherwise, returns descriptions of all file systems owned by the caller's AWS account in the AWS region of the endpoint that you're calling. <para> When retrieving all file system descriptions, you can optionally specify the <code>MaxItems</code> parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon EFS returns a <code>NextMarker</code>, an opaque token, in the response. In this case, you should send a subsequent request with the <code>Marker</code> request parameter set to the value of <code>NextMarker</code>. </para> <para> So to retrieve a list of your file system descriptions, the expected usage of this API is an iterative process of first calling <code>DescribeFileSystems</code> without the <code>Marker</code> and then continuing to call it with the <code>Marker</code> parameter set to the value of the <code>NextMarker</code> from the previous response until the response has no <code>NextMarker</code>. </para> <para> Note that the implementation may return fewer than <code>MaxItems</code> file system descriptions while still including a <code>NextMarker</code> value. </para> <para> The order of file systems returned in the response of one <code>DescribeFileSystems</code> call, and the order of file systems returned across the responses of a multi-call iteration, is unspecified. </para> <para> This operation requires permission for the <code>elasticfilesystem:DescribeFileSystems</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeFileSystems service method.</param> <returns>The response from the DescribeFileSystems service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DescribeFileSystemsAsync(Amazon.ElasticFileSystem.Model.DescribeFileSystemsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeFileSystems operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeFileSystems operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DescribeMountTargets(System.String)"> <summary> Returns the descriptions of the current mount targets for a file system. The order of mount targets returned in the response is unspecified. <para> This operation requires permission for the <code>elasticfilesystem:DescribeMountTargets</code> action on the file system <code>FileSystemId</code>. </para> </summary> <param name="fileSystemId">String. The ID of the file system whose mount targets you want to list.</param> <returns>The response from the DescribeMountTargets service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DescribeMountTargets(Amazon.ElasticFileSystem.Model.DescribeMountTargetsRequest)"> <summary> Returns the descriptions of the current mount targets for a file system. The order of mount targets returned in the response is unspecified. <para> This operation requires permission for the <code>elasticfilesystem:DescribeMountTargets</code> action on the file system <code>FileSystemId</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeMountTargets service method.</param> <returns>The response from the DescribeMountTargets service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DescribeMountTargetsAsync(Amazon.ElasticFileSystem.Model.DescribeMountTargetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeMountTargets operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMountTargets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DescribeMountTargetSecurityGroups(System.String)"> <summary> Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the life cycle state of the mount target is not "deleted". <para> This operation requires permissions for the following actions: </para> <ul> <li> <code>elasticfilesystem:DescribeMountTargetSecurityGroups</code> action on the mount target's file system. </li> <li> <code>ec2:DescribeNetworkInterfaceAttribute</code> action on the mount target's network interface. </li> </ul> </summary> <param name="mountTargetId">The ID of the mount target whose security groups you want to retrieve.</param> <returns>The response from the DescribeMountTargetSecurityGroups service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.IncorrectMountTargetStateException"> Returned if the mount target is not in the correct state for the operation. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.MountTargetNotFoundException"> Returned if there is no mount target with the specified ID is found in the caller's account. </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DescribeMountTargetSecurityGroups(Amazon.ElasticFileSystem.Model.DescribeMountTargetSecurityGroupsRequest)"> <summary> Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the life cycle state of the mount target is not "deleted". <para> This operation requires permissions for the following actions: </para> <ul> <li> <code>elasticfilesystem:DescribeMountTargetSecurityGroups</code> action on the mount target's file system. </li> <li> <code>ec2:DescribeNetworkInterfaceAttribute</code> action on the mount target's network interface. </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DescribeMountTargetSecurityGroups service method.</param> <returns>The response from the DescribeMountTargetSecurityGroups service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.IncorrectMountTargetStateException"> Returned if the mount target is not in the correct state for the operation. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.MountTargetNotFoundException"> Returned if there is no mount target with the specified ID is found in the caller's account. </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DescribeMountTargetSecurityGroupsAsync(Amazon.ElasticFileSystem.Model.DescribeMountTargetSecurityGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeMountTargetSecurityGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMountTargetSecurityGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DescribeTags(System.String)"> <summary> Returns the tags associated with a file system. The order of tags returned in the response of one <code>DescribeTags</code> call, and the order of tags returned across the responses of a multi-call iteration (when using pagination), is unspecified. <para> This operation requires permission for the <code>elasticfilesystem:DescribeTags</code> action. </para> </summary> <param name="fileSystemId">The ID of the file system whose tag set you want to retrieve.</param> <returns>The response from the DescribeTags service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DescribeTags(Amazon.ElasticFileSystem.Model.DescribeTagsRequest)"> <summary> Returns the tags associated with a file system. The order of tags returned in the response of one <code>DescribeTags</code> call, and the order of tags returned across the responses of a multi-call iteration (when using pagination), is unspecified. <para> This operation requires permission for the <code>elasticfilesystem:DescribeTags</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags service method.</param> <returns>The response from the DescribeTags service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.DescribeTagsAsync(Amazon.ElasticFileSystem.Model.DescribeTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.ModifyMountTargetSecurityGroups(Amazon.ElasticFileSystem.Model.ModifyMountTargetSecurityGroupsRequest)"> <summary> Modifies the set of security groups in effect for a mount target. <para> When you create a mount target, Amazon EFS also creates a new network interface (see <a>CreateMountTarget</a>). This operation replaces the security groups in effect for the network interface associated with a mount target, with the <code>SecurityGroups</code> provided in the request. This operation requires that the network interface of the mount target has been created and the life cycle state of the mount target is not "deleted". </para> <para> The operation requires permissions for the following actions: </para> <ul> <li> <code>elasticfilesystem:ModifyMountTargetSecurityGroups</code> action on the mount target's file system. </li> <li> <code>ec2:ModifyNetworkInterfaceAttribute</code> action on the mount target's network interface. </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the ModifyMountTargetSecurityGroups service method.</param> <returns>The response from the ModifyMountTargetSecurityGroups service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.IncorrectMountTargetStateException"> Returned if the mount target is not in the correct state for the operation. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.MountTargetNotFoundException"> Returned if there is no mount target with the specified ID is found in the caller's account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.SecurityGroupLimitExceededException"> Returned if the size of <code>SecurityGroups</code> specified in the request is greater than five. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.SecurityGroupNotFoundException"> Returned if one of the specified security groups does not exist in the subnet's VPC. </exception> </member> <member name="M:Amazon.ElasticFileSystem.IAmazonElasticFileSystem.ModifyMountTargetSecurityGroupsAsync(Amazon.ElasticFileSystem.Model.ModifyMountTargetSecurityGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyMountTargetSecurityGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyMountTargetSecurityGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.#ctor"> <summary> Constructs AmazonElasticFileSystemClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticFileSystemClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.#ctor(Amazon.ElasticFileSystem.AmazonElasticFileSystemConfig)"> <summary> Constructs AmazonElasticFileSystemClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonElasticFileSystemClient Configuration Object</param> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonElasticFileSystemClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticFileSystemClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.ElasticFileSystem.AmazonElasticFileSystemConfig)"> <summary> Constructs AmazonElasticFileSystemClient with AWS Credentials and an AmazonElasticFileSystemClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonElasticFileSystemClient Configuration Object</param> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonElasticFileSystemClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticFileSystemClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.#ctor(System.String,System.String,Amazon.ElasticFileSystem.AmazonElasticFileSystemConfig)"> <summary> Constructs AmazonElasticFileSystemClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticFileSystemClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonElasticFileSystemClient Configuration Object</param> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonElasticFileSystemClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticFileSystemClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.#ctor(System.String,System.String,System.String,Amazon.ElasticFileSystem.AmazonElasticFileSystemConfig)"> <summary> Constructs AmazonElasticFileSystemClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticFileSystemClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonElasticFileSystemClient Configuration Object</param> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.CreateFileSystem(System.String)"> <summary> Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following: <ul> <li>Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state "creating". </li> <li> Returns with the description of the created file system. </li> </ul> <para> Otherwise, this operation returns a <code>FileSystemAlreadyExists</code> error with the ID of the existing file system. </para> <note>For basic use cases, you can use a randomly generated UUID for the creation token.</note> <para> The idempotent operation allows you to retry a <code>CreateFileSystem</code> call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the <code>FileSystemAlreadyExists</code> error. </para> <note>The <code>CreateFileSystem</code> call returns while the file system's lifecycle state is still "creating". You can check the file system creation status by calling the <a>DescribeFileSystems</a> API, which among other things returns the file system state.</note> <para> After the file system is fully created, Amazon EFS sets its lifecycle state to "available", at which point you can create one or more mount targets for the file system (<a>CreateMountTarget</a>) in your VPC. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see <a href="http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html">Amazon EFS: How it Works</a> </para> <para> This operation requires permission for the <code>elasticfilesystem:CreateFileSystem</code> action. </para> </summary> <param name="creationToken">String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.</param> <returns>The response from the CreateFileSystem service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemAlreadyExistsException"> Returned if the file system you are trying to create already exists, with the creation token you provided. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemLimitExceededException"> Returned if the AWS account has already created maximum number of file systems allowed per account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.CreateFileSystem(Amazon.ElasticFileSystem.Model.CreateFileSystemRequest)"> <summary> Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following: <ul> <li>Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state "creating". </li> <li> Returns with the description of the created file system. </li> </ul> <para> Otherwise, this operation returns a <code>FileSystemAlreadyExists</code> error with the ID of the existing file system. </para> <note>For basic use cases, you can use a randomly generated UUID for the creation token.</note> <para> The idempotent operation allows you to retry a <code>CreateFileSystem</code> call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the <code>FileSystemAlreadyExists</code> error. </para> <note>The <code>CreateFileSystem</code> call returns while the file system's lifecycle state is still "creating". You can check the file system creation status by calling the <a>DescribeFileSystems</a> API, which among other things returns the file system state.</note> <para> After the file system is fully created, Amazon EFS sets its lifecycle state to "available", at which point you can create one or more mount targets for the file system (<a>CreateMountTarget</a>) in your VPC. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see <a href="http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html">Amazon EFS: How it Works</a> </para> <para> This operation requires permission for the <code>elasticfilesystem:CreateFileSystem</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateFileSystem service method.</param> <returns>The response from the CreateFileSystem service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemAlreadyExistsException"> Returned if the file system you are trying to create already exists, with the creation token you provided. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemLimitExceededException"> Returned if the AWS account has already created maximum number of file systems allowed per account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.CreateFileSystemAsync(Amazon.ElasticFileSystem.Model.CreateFileSystemRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateFileSystem operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateFileSystem operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.CreateMountTarget(Amazon.ElasticFileSystem.Model.CreateMountTargetRequest)"> <summary> Creates a mount target for a file system. You can then mount the file system on EC2 instances via the mount target. <para> You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see <a href="http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html">Amazon EFS: How it Works</a>. </para> <para> In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be "available" (see <a>DescribeFileSystems</a>). </para> <para> In the request, you also provide a subnet ID, which serves several purposes: </para> <ul> <li>It determines the VPC in which Amazon EFS creates the mount target.</li> <li>It determines the Availability Zone in which Amazon EFS creates the mount target. </li> <li>It determines the IP address range from which Amazon EFS selects the IP address of the mount target if you don't specify an IP address in the request. </li> </ul> <para> After creating the mount target, Amazon EFS returns a response that includes, a <code>MountTargetId</code> and an <code>IpAddress</code>. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system via the mount target can resolve the mount target's DNS name to its IP address. For more information, see <a href="http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation">How it Works: Implementation Overview</a> </para> <para> Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the request to add another mount target must meet the following requirements: </para> <ul> <li> <para> The subnet specified in the request must belong to the same VPC as the subnets of the existing mount targets. </para> </li> <li>The subnet specified in the request must not be in the same Availability Zone as any of the subnets of the existing mount targets.</li> </ul> <para> If the request satisfies the requirements, Amazon EFS does the following: </para> <ul> <li>Creates a new mount target in the specified subnet. </li> <li>Also creates a new network interface in the subnet as follows: <ul> <li>If the request provides an <code>IpAddress</code>, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 <code>CreateNetworkInterface</code> call does when a request does not specify a primary private IP address).</li> <li>If the request provides <code>SecurityGroups</code>, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.</li> <li>Assigns the description <code>"Mount target <i>fsmt-id</i> for file system <i>fs-id</i>"</code> where <code><i>fsmt-id</i></code> is the mount target ID, and <code><i>fs-id</i></code> is the <code>FileSystemId</code>.</li> <li>Sets the <code>requesterManaged</code> property of the network interface to "true", and the <code>requesterId</code> value to "EFS".</li> </ul> <para> Each Amazon EFS mount target has one corresponding requestor-managed EC2 network interface. After the network interface is created, Amazon EFS sets the <code>NetworkInterfaceId</code> field in the mount target's description to the network interface ID, and the <code>IpAddress</code> field to its address. If network interface creation fails, the entire <code>CreateMountTarget</code> operation fails. </para> </li> </ul> <note>The <code>CreateMountTarget</code> call returns only after creating the network interface, but while the mount target state is still "creating". You can check the mount target creation status by calling the <a>DescribeFileSystems</a> API, which among other things returns the mount target state.</note> <para> We recommend you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, go to <a href="http://aws.amazon.com/efs/">Amazon EFS</a> product detail page. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario; if the Availablity Zone in which your mount target is created goes down, then you won't be able to access your file system through that mount target. </para> <para> This operation requires permission for the following action on the file system: </para> <ul> <li><code>elasticfilesystem:CreateMountTarget</code></li> </ul> <para> This operation also requires permission for the following Amazon EC2 actions: </para> <ul> <li><code>ec2:DescribeSubnets</code></li> <li><code>ec2:DescribeNetworkInterfaces</code></li> <li><code>ec2:CreateNetworkInterface</code></li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the CreateMountTarget service method.</param> <returns>The response from the CreateMountTarget service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.IncorrectFileSystemLifeCycleStateException"> Returned if the file system's life cycle state is not "created". </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.IpAddressInUseException"> Returned if the request specified an <code>IpAddress</code> that is already in use in the subnet. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.MountTargetConflictException"> Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.NetworkInterfaceLimitExceededException"> The calling account has reached the ENI limit for the specific AWS region. Client should try to delete some ENIs or get its account limit raised. For more information, go to <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html">Amazon VPC Limits</a> in the Amazon Virtual Private Cloud User Guide (see the Network interfaces per VPC entry in the table). </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.NoFreeAddressesInSubnetException"> Returned if <code>IpAddress</code> was not specified in the request and there are no free IP addresses in the subnet. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.SecurityGroupLimitExceededException"> Returned if the size of <code>SecurityGroups</code> specified in the request is greater than five. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.SecurityGroupNotFoundException"> Returned if one of the specified security groups does not exist in the subnet's VPC. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.SubnetNotFoundException"> Returned if there is no subnet with ID <code>SubnetId</code> provided in the request. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.UnsupportedAvailabilityZoneException"> </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.CreateMountTargetAsync(Amazon.ElasticFileSystem.Model.CreateMountTargetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateMountTarget operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateMountTarget operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.CreateTags(Amazon.ElasticFileSystem.Model.CreateTagsRequest)"> <summary> Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the "Name" tag to your file system, Amazon EFS returns it in the response to the <a>DescribeFileSystems</a> API. <para> This operation requires permission for the <code>elasticfilesystem:CreateTags</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateTags service method.</param> <returns>The response from the CreateTags service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.CreateTagsAsync(Amazon.ElasticFileSystem.Model.CreateTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTags operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DeleteFileSystem(System.String)"> <summary> Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you will not be able to access any contents of the deleted file system. <para> You cannot delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see <a>DescribeMountTargets</a> and <a>DeleteMountTarget</a>. </para> <note>The <code>DeleteFileSystem</code> call returns while the file system state is still "deleting". You can check the file system deletion status by calling the <a>DescribeFileSystems</a> API, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the <a>DescribeFileSystems</a> will return a 404 "FileSystemNotFound" error.</note> <para> This operation requires permission for the <code>elasticfilesystem:DeleteFileSystem</code> action. </para> </summary> <param name="fileSystemId">The ID of the file system you want to delete.</param> <returns>The response from the DeleteFileSystem service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemInUseException"> Returned if a file system has mount targets. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DeleteFileSystem(Amazon.ElasticFileSystem.Model.DeleteFileSystemRequest)"> <summary> Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you will not be able to access any contents of the deleted file system. <para> You cannot delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see <a>DescribeMountTargets</a> and <a>DeleteMountTarget</a>. </para> <note>The <code>DeleteFileSystem</code> call returns while the file system state is still "deleting". You can check the file system deletion status by calling the <a>DescribeFileSystems</a> API, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the <a>DescribeFileSystems</a> will return a 404 "FileSystemNotFound" error.</note> <para> This operation requires permission for the <code>elasticfilesystem:DeleteFileSystem</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteFileSystem service method.</param> <returns>The response from the DeleteFileSystem service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemInUseException"> Returned if a file system has mount targets. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DeleteFileSystemAsync(Amazon.ElasticFileSystem.Model.DeleteFileSystemRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteFileSystem operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteFileSystem operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DeleteMountTarget(System.String)"> <summary> Deletes the specified mount target. <para> This operation forcibly breaks any mounts of the file system via the mount target being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC using another mount target. </para> <para> This operation requires permission for the following action on the file system: </para> <ul> <li><code>elasticfilesystem:DeleteMountTarget</code></li> </ul> <note>The <code>DeleteMountTarget</code> call returns while the mount target state is still "deleting". You can check the mount target deletion by calling the <a>DescribeMountTargets</a> API, which returns a list of mount target descriptions for the given file system. </note> <para> The operation also requires permission for the following Amazon EC2 action on the mount target's network interface: </para> <ul> <li><code>ec2:DeleteNetworkInterface</code></li> </ul> </summary> <param name="mountTargetId">String. The ID of the mount target to delete.</param> <returns>The response from the DeleteMountTarget service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.DependencyTimeoutException"> The service timed out trying to fulfill the request, and the client should try the call again. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.MountTargetNotFoundException"> Returned if there is no mount target with the specified ID is found in the caller's account. </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DeleteMountTarget(Amazon.ElasticFileSystem.Model.DeleteMountTargetRequest)"> <summary> Deletes the specified mount target. <para> This operation forcibly breaks any mounts of the file system via the mount target being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC using another mount target. </para> <para> This operation requires permission for the following action on the file system: </para> <ul> <li><code>elasticfilesystem:DeleteMountTarget</code></li> </ul> <note>The <code>DeleteMountTarget</code> call returns while the mount target state is still "deleting". You can check the mount target deletion by calling the <a>DescribeMountTargets</a> API, which returns a list of mount target descriptions for the given file system. </note> <para> The operation also requires permission for the following Amazon EC2 action on the mount target's network interface: </para> <ul> <li><code>ec2:DeleteNetworkInterface</code></li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DeleteMountTarget service method.</param> <returns>The response from the DeleteMountTarget service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.DependencyTimeoutException"> The service timed out trying to fulfill the request, and the client should try the call again. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.MountTargetNotFoundException"> Returned if there is no mount target with the specified ID is found in the caller's account. </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DeleteMountTargetAsync(Amazon.ElasticFileSystem.Model.DeleteMountTargetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteMountTarget operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteMountTarget operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DeleteTags(Amazon.ElasticFileSystem.Model.DeleteTagsRequest)"> <summary> Deletes the specified tags from a file system. If the <code>DeleteTags</code> request includes a tag key that does not exist, Amazon EFS ignores it; it is not an error. For more information about tags and related restrictions, go to <a href="http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Tag Restrictions</a> in the <i>AWS Billing and Cost Management User Guide</i>. <para> This operation requires permission for the <code>elasticfilesystem:DeleteTags</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags service method.</param> <returns>The response from the DeleteTags service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DeleteTagsAsync(Amazon.ElasticFileSystem.Model.DeleteTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DescribeFileSystems(Amazon.ElasticFileSystem.Model.DescribeFileSystemsRequest)"> <summary> Returns the description of a specific Amazon EFS file system if either the file system <code>CreationToken</code> or the <code>FileSystemId</code> is provided; otherwise, returns descriptions of all file systems owned by the caller's AWS account in the AWS region of the endpoint that you're calling. <para> When retrieving all file system descriptions, you can optionally specify the <code>MaxItems</code> parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon EFS returns a <code>NextMarker</code>, an opaque token, in the response. In this case, you should send a subsequent request with the <code>Marker</code> request parameter set to the value of <code>NextMarker</code>. </para> <para> So to retrieve a list of your file system descriptions, the expected usage of this API is an iterative process of first calling <code>DescribeFileSystems</code> without the <code>Marker</code> and then continuing to call it with the <code>Marker</code> parameter set to the value of the <code>NextMarker</code> from the previous response until the response has no <code>NextMarker</code>. </para> <para> Note that the implementation may return fewer than <code>MaxItems</code> file system descriptions while still including a <code>NextMarker</code> value. </para> <para> The order of file systems returned in the response of one <code>DescribeFileSystems</code> call, and the order of file systems returned across the responses of a multi-call iteration, is unspecified. </para> <para> This operation requires permission for the <code>elasticfilesystem:DescribeFileSystems</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeFileSystems service method.</param> <returns>The response from the DescribeFileSystems service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DescribeFileSystemsAsync(Amazon.ElasticFileSystem.Model.DescribeFileSystemsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeFileSystems operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeFileSystems operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DescribeMountTargets(System.String)"> <summary> Returns the descriptions of the current mount targets for a file system. The order of mount targets returned in the response is unspecified. <para> This operation requires permission for the <code>elasticfilesystem:DescribeMountTargets</code> action on the file system <code>FileSystemId</code>. </para> </summary> <param name="fileSystemId">String. The ID of the file system whose mount targets you want to list.</param> <returns>The response from the DescribeMountTargets service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DescribeMountTargets(Amazon.ElasticFileSystem.Model.DescribeMountTargetsRequest)"> <summary> Returns the descriptions of the current mount targets for a file system. The order of mount targets returned in the response is unspecified. <para> This operation requires permission for the <code>elasticfilesystem:DescribeMountTargets</code> action on the file system <code>FileSystemId</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeMountTargets service method.</param> <returns>The response from the DescribeMountTargets service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DescribeMountTargetsAsync(Amazon.ElasticFileSystem.Model.DescribeMountTargetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeMountTargets operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMountTargets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DescribeMountTargetSecurityGroups(System.String)"> <summary> Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the life cycle state of the mount target is not "deleted". <para> This operation requires permissions for the following actions: </para> <ul> <li> <code>elasticfilesystem:DescribeMountTargetSecurityGroups</code> action on the mount target's file system. </li> <li> <code>ec2:DescribeNetworkInterfaceAttribute</code> action on the mount target's network interface. </li> </ul> </summary> <param name="mountTargetId">The ID of the mount target whose security groups you want to retrieve.</param> <returns>The response from the DescribeMountTargetSecurityGroups service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.IncorrectMountTargetStateException"> Returned if the mount target is not in the correct state for the operation. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.MountTargetNotFoundException"> Returned if there is no mount target with the specified ID is found in the caller's account. </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DescribeMountTargetSecurityGroups(Amazon.ElasticFileSystem.Model.DescribeMountTargetSecurityGroupsRequest)"> <summary> Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the life cycle state of the mount target is not "deleted". <para> This operation requires permissions for the following actions: </para> <ul> <li> <code>elasticfilesystem:DescribeMountTargetSecurityGroups</code> action on the mount target's file system. </li> <li> <code>ec2:DescribeNetworkInterfaceAttribute</code> action on the mount target's network interface. </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DescribeMountTargetSecurityGroups service method.</param> <returns>The response from the DescribeMountTargetSecurityGroups service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.IncorrectMountTargetStateException"> Returned if the mount target is not in the correct state for the operation. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.MountTargetNotFoundException"> Returned if there is no mount target with the specified ID is found in the caller's account. </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DescribeMountTargetSecurityGroupsAsync(Amazon.ElasticFileSystem.Model.DescribeMountTargetSecurityGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeMountTargetSecurityGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMountTargetSecurityGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DescribeTags(System.String)"> <summary> Returns the tags associated with a file system. The order of tags returned in the response of one <code>DescribeTags</code> call, and the order of tags returned across the responses of a multi-call iteration (when using pagination), is unspecified. <para> This operation requires permission for the <code>elasticfilesystem:DescribeTags</code> action. </para> </summary> <param name="fileSystemId">The ID of the file system whose tag set you want to retrieve.</param> <returns>The response from the DescribeTags service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DescribeTags(Amazon.ElasticFileSystem.Model.DescribeTagsRequest)"> <summary> Returns the tags associated with a file system. The order of tags returned in the response of one <code>DescribeTags</code> call, and the order of tags returned across the responses of a multi-call iteration (when using pagination), is unspecified. <para> This operation requires permission for the <code>elasticfilesystem:DescribeTags</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags service method.</param> <returns>The response from the DescribeTags service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.FileSystemNotFoundException"> Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.DescribeTagsAsync(Amazon.ElasticFileSystem.Model.DescribeTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.ModifyMountTargetSecurityGroups(Amazon.ElasticFileSystem.Model.ModifyMountTargetSecurityGroupsRequest)"> <summary> Modifies the set of security groups in effect for a mount target. <para> When you create a mount target, Amazon EFS also creates a new network interface (see <a>CreateMountTarget</a>). This operation replaces the security groups in effect for the network interface associated with a mount target, with the <code>SecurityGroups</code> provided in the request. This operation requires that the network interface of the mount target has been created and the life cycle state of the mount target is not "deleted". </para> <para> The operation requires permissions for the following actions: </para> <ul> <li> <code>elasticfilesystem:ModifyMountTargetSecurityGroups</code> action on the mount target's file system. </li> <li> <code>ec2:ModifyNetworkInterfaceAttribute</code> action on the mount target's network interface. </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the ModifyMountTargetSecurityGroups service method.</param> <returns>The response from the ModifyMountTargetSecurityGroups service method, as returned by ElasticFileSystem.</returns> <exception cref="T:Amazon.ElasticFileSystem.Model.BadRequestException"> Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.IncorrectMountTargetStateException"> Returned if the mount target is not in the correct state for the operation. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.InternalServerErrorException"> Returned if an error occurred on the server side. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.MountTargetNotFoundException"> Returned if there is no mount target with the specified ID is found in the caller's account. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.SecurityGroupLimitExceededException"> Returned if the size of <code>SecurityGroups</code> specified in the request is greater than five. </exception> <exception cref="T:Amazon.ElasticFileSystem.Model.SecurityGroupNotFoundException"> Returned if one of the specified security groups does not exist in the subnet's VPC. </exception> </member> <member name="M:Amazon.ElasticFileSystem.AmazonElasticFileSystemClient.ModifyMountTargetSecurityGroupsAsync(Amazon.ElasticFileSystem.Model.ModifyMountTargetSecurityGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyMountTargetSecurityGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyMountTargetSecurityGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient"> <summary> Implementation for accessing ElasticLoadBalancing Elastic Load Balancing <para> Elastic Load Balancing distributes incoming traffic across your EC2 instances. </para> <para> For information about the features of Elastic Load Balancing, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elastic-load-balancing.html">What Is Elastic Load Balancing?</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> <para> For information about the AWS regions supported by Elastic Load Balancing, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#elb_region">Regions and Endpoints - Elastic Load Balancing</a> in the <i>Amazon Web Services General Reference</i>. </para> <para> All Elastic Load Balancing operations are <i>idempotent</i>, which means that they complete at most one time. If you repeat an operation, it succeeds with a 200 OK response code. </para> </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing"> <summary> Interface for accessing ElasticLoadBalancing Elastic Load Balancing <para> Elastic Load Balancing distributes incoming traffic across your EC2 instances. </para> <para> For information about the features of Elastic Load Balancing, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elastic-load-balancing.html">What Is Elastic Load Balancing?</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> <para> For information about the AWS regions supported by Elastic Load Balancing, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#elb_region">Regions and Endpoints - Elastic Load Balancing</a> in the <i>Amazon Web Services General Reference</i>. </para> <para> All Elastic Load Balancing operations are <i>idempotent</i>, which means that they complete at most one time. If you repeat an operation, it succeeds with a 200 OK response code. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.AddTags(Amazon.ElasticLoadBalancing.Model.AddTagsRequest)"> <summary> Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags. <para> Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, <code>AddTags</code> updates its value. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/add-remove-tags.html">Tag Your Load Balancer</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddTags service method.</param> <returns>The response from the AddTags service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicateTagKeysException"> A tag key was specified more than once. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyTagsException"> The quota for the number of tags that can be assigned to a load balancer has been reached. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.AddTagsAsync(Amazon.ElasticLoadBalancing.Model.AddTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTags operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.ApplySecurityGroupsToLoadBalancer(Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest)"> <summary> Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups. <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-security-groups.html#elb-vpc-security-groups">Security Groups for Load Balancers in a VPC</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ApplySecurityGroupsToLoadBalancer service method.</param> <returns>The response from the ApplySecurityGroupsToLoadBalancer service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSecurityGroupException"> One or more of the specified security groups do not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.ApplySecurityGroupsToLoadBalancerAsync(Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ApplySecurityGroupsToLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the ApplySecurityGroupsToLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.AttachLoadBalancerToSubnets(Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest)"> <summary> Adds one or more subnets to the set of configured subnets for the specified load balancer. <para> The load balancer evenly distributes requests across all registered subnets. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-manage-subnets.html">Add or Remove Subnets for Your Load Balancer in a VPC</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachLoadBalancerToSubnets service method.</param> <returns>The response from the AttachLoadBalancerToSubnets service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSubnetException"> The specified VPC has no associated Internet gateway. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.SubnetNotFoundException"> One or more of the specified subnets do not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.AttachLoadBalancerToSubnetsAsync(Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachLoadBalancerToSubnets operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachLoadBalancerToSubnets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.ConfigureHealthCheck(Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest)"> <summary> Specifies the health check settings to use when evaluating the health state of your back-end instances. <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-healthchecks.html">Configure Health Checks</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ConfigureHealthCheck service method.</param> <returns>The response from the ConfigureHealthCheck service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.ConfigureHealthCheckAsync(Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ConfigureHealthCheck operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfigureHealthCheck operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.CreateAppCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest)"> <summary> Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners. <para> This policy is similar to the policy created by <a>CreateLBCookieStickinessPolicy</a>, except that the lifetime of the special Elastic Load Balancing cookie, <code>AWSELB</code>, follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie. </para> <para> If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-sticky-sessions.html#enable-sticky-sessions-application">Application-Controlled Session Stickiness</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateAppCookieStickinessPolicy service method.</param> <returns>The response from the CreateAppCookieStickinessPolicy service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicatePolicyNameException"> A policy with the specified name already exists for this load balancer. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyPoliciesException"> The quota for the number of policies for this load balancer has been reached. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.CreateAppCookieStickinessPolicyAsync(Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAppCookieStickinessPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAppCookieStickinessPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.CreateLBCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest)"> <summary> Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners. <para> When a load balancer implements this policy, the load balancer uses a special cookie to track the back-end server instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm. </para> <para> A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-sticky-sessions.html#enable-sticky-sessions-duration">Duration-Based Session Stickiness</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLBCookieStickinessPolicy service method.</param> <returns>The response from the CreateLBCookieStickinessPolicy service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicatePolicyNameException"> A policy with the specified name already exists for this load balancer. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyPoliciesException"> The quota for the number of policies for this load balancer has been reached. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.CreateLBCookieStickinessPolicyAsync(Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLBCookieStickinessPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLBCookieStickinessPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.CreateLoadBalancer(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest)"> <summary> Creates a load balancer. <para> If the call completes successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The load balancer receives incoming traffic and routes it to the registered instances. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/how-elb-works.html">How Elastic Load Balancing Works</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> <para> You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-limits.html">Elastic Load Balancing Limits</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLoadBalancer service method.</param> <returns>The response from the CreateLoadBalancer service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.CertificateNotFoundException"> The specified SSL ID does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM). </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicateAccessPointNameException"> The specified load balancer name already exists for this account. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicateTagKeysException"> A tag key was specified more than once. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSchemeException"> The specified value for the schema is not valid. You can only specify a scheme for load balancers in a VPC. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSecurityGroupException"> One or more of the specified security groups do not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSubnetException"> The specified VPC has no associated Internet gateway. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.SubnetNotFoundException"> One or more of the specified subnets do not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyAccessPointsException"> The quota for the number of load balancers has been reached. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyTagsException"> The quota for the number of tags that can be assigned to a load balancer has been reached. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.CreateLoadBalancerAsync(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.CreateLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest)"> <summary> Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener. <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/us-add-listener.html">Add a Listener to Your Load Balancer</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLoadBalancerListeners service method.</param> <returns>The response from the CreateLoadBalancerListeners service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.CertificateNotFoundException"> The specified SSL ID does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM). </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicateListenerException"> A listener already exists for the specified <code>LoadBalancerName</code> and <code>LoadBalancerPort</code>, but with a different <code>InstancePort</code>, <code>Protocol</code>, or <code>SSLCertificateId</code>. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.CreateLoadBalancerListenersAsync(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLoadBalancerListeners operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLoadBalancerListeners operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.CreateLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest)"> <summary> Creates a policy with the specified attributes for the specified load balancer. <para> Policies are settings that are saved for your load balancer and that can be applied to the front-end listener or the back-end application server, depending on the policy type. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLoadBalancerPolicy service method.</param> <returns>The response from the CreateLoadBalancerPolicy service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicatePolicyNameException"> A policy with the specified name already exists for this load balancer. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyTypeNotFoundException"> One or more of the specified policy types do not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyPoliciesException"> The quota for the number of policies for this load balancer has been reached. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.CreateLoadBalancerPolicyAsync(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLoadBalancerPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLoadBalancerPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DeleteLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest)"> <summary> Deletes the specified load balancer. <para> If you are attempting to recreate a load balancer, you must reconfigure all settings. The DNS name associated with a deleted load balancer are no longer usable. The name and associated DNS record of the deleted load balancer no longer exist and traffic sent to any of its IP addresses is no longer delivered to back-end instances. </para> <para> If the load balancer does not exist or has already been deleted, the call to <code>DeleteLoadBalancer</code> still succeeds. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoadBalancer service method.</param> <returns>The response from the DeleteLoadBalancer service method, as returned by ElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DeleteLoadBalancerAsync(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DeleteLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest)"> <summary> Deletes the specified listeners from the specified load balancer. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoadBalancerListeners service method.</param> <returns>The response from the DeleteLoadBalancerListeners service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DeleteLoadBalancerListenersAsync(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLoadBalancerListeners operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoadBalancerListeners operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DeleteLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest)"> <summary> Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoadBalancerPolicy service method.</param> <returns>The response from the DeleteLoadBalancerPolicy service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DeleteLoadBalancerPolicyAsync(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLoadBalancerPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoadBalancerPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DeregisterInstancesFromLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest)"> <summary> Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer. <para> You can use <a>DescribeLoadBalancers</a> to verify that the instance is deregistered from the load balancer. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_DeReg_Reg_Instances.html">Deregister and Register Amazon EC2 Instances</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterInstancesFromLoadBalancer service method.</param> <returns>The response from the DeregisterInstancesFromLoadBalancer service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidEndPointException"> The specified endpoint is not valid. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DeregisterInstancesFromLoadBalancerAsync(Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterInstancesFromLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterInstancesFromLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DescribeInstanceHealth(Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest)"> <summary> Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceHealth service method.</param> <returns>The response from the DescribeInstanceHealth service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidEndPointException"> The specified endpoint is not valid. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DescribeInstanceHealthAsync(Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInstanceHealth operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceHealth operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DescribeLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesRequest)"> <summary> Describes the attributes for the specified load balancer. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancerAttributes service method.</param> <returns>The response from the DescribeLoadBalancerAttributes service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributeNotFoundException"> The specified load balancer attribute does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DescribeLoadBalancerAttributesAsync(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancerAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancerAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DescribeLoadBalancerPolicies"> <summary> Describes the specified policies. <para> If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. The names of the sample policies have the <code>ELBSample-</code> prefix. </para> </summary> <returns>The response from the DescribeLoadBalancerPolicies service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"> One or more of the specified policies do not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DescribeLoadBalancerPolicies(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest)"> <summary> Describes the specified policies. <para> If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. The names of the sample policies have the <code>ELBSample-</code> prefix. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancerPolicies service method.</param> <returns>The response from the DescribeLoadBalancerPolicies service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"> One or more of the specified policies do not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DescribeLoadBalancerPoliciesAsync(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancerPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancerPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DescribeLoadBalancerPolicyTypes"> <summary> Describes the specified load balancer policy types. <para> You can use these policy types with <a>CreateLoadBalancerPolicy</a> to create policy configurations for a load balancer. </para> </summary> <returns>The response from the DescribeLoadBalancerPolicyTypes service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyTypeNotFoundException"> One or more of the specified policy types do not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DescribeLoadBalancerPolicyTypes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest)"> <summary> Describes the specified load balancer policy types. <para> You can use these policy types with <a>CreateLoadBalancerPolicy</a> to create policy configurations for a load balancer. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancerPolicyTypes service method.</param> <returns>The response from the DescribeLoadBalancerPolicyTypes service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyTypeNotFoundException"> One or more of the specified policy types do not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DescribeLoadBalancerPolicyTypesAsync(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancerPolicyTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancerPolicyTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DescribeLoadBalancers"> <summary> Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers. </summary> <returns>The response from the DescribeLoadBalancers service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DescribeLoadBalancers(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest)"> <summary> Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancers service method.</param> <returns>The response from the DescribeLoadBalancers service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DescribeLoadBalancersAsync(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancers operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DescribeTags(Amazon.ElasticLoadBalancing.Model.DescribeTagsRequest)"> <summary> Describes the tags associated with the specified load balancers. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags service method.</param> <returns>The response from the DescribeTags service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DescribeTagsAsync(Amazon.ElasticLoadBalancing.Model.DescribeTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DetachLoadBalancerFromSubnets(Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest)"> <summary> Removes the specified subnets from the set of configured subnets for the load balancer. <para> After a subnet is removed, all EC2 instances registered with the load balancer in the removed subnet go into the <code>OutOfService</code> state. Then, the load balancer balances the traffic among the remaining routable subnets. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachLoadBalancerFromSubnets service method.</param> <returns>The response from the DetachLoadBalancerFromSubnets service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DetachLoadBalancerFromSubnetsAsync(Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachLoadBalancerFromSubnets operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachLoadBalancerFromSubnets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DisableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest)"> <summary> Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer. <para> There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the <code>OutOfService</code> state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_ShrinkLBApp04.html">Disable an Availability Zone from a Load-Balanced Application</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DisableAvailabilityZonesForLoadBalancer service method.</param> <returns>The response from the DisableAvailabilityZonesForLoadBalancer service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.DisableAvailabilityZonesForLoadBalancerAsync(Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableAvailabilityZonesForLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableAvailabilityZonesForLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.EnableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest)"> <summary> Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer. <para> The load balancer evenly distributes requests across all its registered Availability Zones that contain instances. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_AddLBAvailabilityZone.html">Add Availability Zone</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the EnableAvailabilityZonesForLoadBalancer service method.</param> <returns>The response from the EnableAvailabilityZonesForLoadBalancer service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.EnableAvailabilityZonesForLoadBalancerAsync(Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableAvailabilityZonesForLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableAvailabilityZonesForLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.ModifyLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest)"> <summary> Modifies the attributes of the specified load balancer. <para> You can modify the load balancer attributes, such as <code>AccessLogs</code>, <code>ConnectionDraining</code>, and <code>CrossZoneLoadBalancing</code> by either enabling or disabling them. Or, you can modify the load balancer attribute <code>ConnectionSettings</code> by specifying an idle connection timeout value for your load balancer. </para> <para> For more information, see the following in the <i>Elastic Load Balancing Developer Guide</i>: </para> <ul> <li><a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#request-routing">Cross-Zone Load Balancing</a></li> <li><a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain">Connection Draining</a></li> <li><a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/access-log-collection.html">Access Logs</a></li> <li><a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#idle-timeout">Idle Connection Timeout</a></li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the ModifyLoadBalancerAttributes service method.</param> <returns>The response from the ModifyLoadBalancerAttributes service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributeNotFoundException"> The specified load balancer attribute does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.ModifyLoadBalancerAttributesAsync(Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyLoadBalancerAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyLoadBalancerAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.RegisterInstancesWithLoadBalancer(Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest)"> <summary> Adds the specified instances to the specified load balancer. <para> The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC. </para> <para> Note that <code>RegisterInstanceWithLoadBalancer</code> completes when the request has been registered. Instance registration takes a little time to complete. To check the state of the registered instances, use <a>DescribeLoadBalancers</a> or <a>DescribeInstanceHealth</a>. </para> <para> After the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in one of the Availability Zones registered for the load balancer is moved to the <code>OutOfService</code> state. If an Availability Zone is added to the load balancer later, any instances registered with the load balancer move to the <code>InService</code> state. </para> <para> If you stop an instance registered with a load balancer and then start it, the IP addresses associated with the instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to the instances. We recommend that you use the following sequence: stop the instance, deregister the instance, start the instance, and then register the instance. To deregister instances from a load balancer, use <a>DeregisterInstancesFromLoadBalancer</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_DeReg_Reg_Instances.html">Deregister and Register EC2 Instances</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterInstancesWithLoadBalancer service method.</param> <returns>The response from the RegisterInstancesWithLoadBalancer service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidEndPointException"> The specified endpoint is not valid. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.RegisterInstancesWithLoadBalancerAsync(Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterInstancesWithLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterInstancesWithLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.RemoveTags(Amazon.ElasticLoadBalancing.Model.RemoveTagsRequest)"> <summary> Removes one or more tags from the specified load balancer. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags service method.</param> <returns>The response from the RemoveTags service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.RemoveTagsAsync(Amazon.ElasticLoadBalancing.Model.RemoveTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTags operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.SetLoadBalancerListenerSSLCertificate(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest)"> <summary> Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port. <para> For more information about updating your SSL certificate, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_UpdatingLoadBalancerSSL.html">Updating an SSL Certificate for a Load Balancer</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetLoadBalancerListenerSSLCertificate service method.</param> <returns>The response from the SetLoadBalancerListenerSSLCertificate service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.CertificateNotFoundException"> The specified SSL ID does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM). </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.ListenerNotFoundException"> The load balancer does not have a listener configured at the specified port. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.SetLoadBalancerListenerSSLCertificateAsync(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetLoadBalancerListenerSSLCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the SetLoadBalancerListenerSSLCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.SetLoadBalancerPoliciesForBackendServer(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest)"> <summary> Replaces the set of policies associated with the specified port on which the back-end server is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the back-end ports; this policy type is composed of multiple public key policies. <para> Each time you use <code>SetLoadBalancerPoliciesForBackendServer</code> to enable the policies, use the <code>PolicyNames</code> parameter to list the policies that you want to enable. </para> <para> You can use <a>DescribeLoadBalancers</a> or <a>DescribeLoadBalancerPolicies</a> to verify that the policy is associated with the back-end server. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetLoadBalancerPoliciesForBackendServer service method.</param> <returns>The response from the SetLoadBalancerPoliciesForBackendServer service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"> One or more of the specified policies do not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.SetLoadBalancerPoliciesForBackendServerAsync(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetLoadBalancerPoliciesForBackendServer operation. </summary> <param name="request">Container for the necessary parameters to execute the SetLoadBalancerPoliciesForBackendServer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.SetLoadBalancerPoliciesOfListener(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest)"> <summary> Associates, updates, or disables a policy with a listener for the specified load balancer. You can associate multiple policies with a listener. </summary> <param name="request">Container for the necessary parameters to execute the SetLoadBalancerPoliciesOfListener service method.</param> <returns>The response from the SetLoadBalancerPoliciesOfListener service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.ListenerNotFoundException"> The load balancer does not have a listener configured at the specified port. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"> One or more of the specified policies do not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing.SetLoadBalancerPoliciesOfListenerAsync(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetLoadBalancerPoliciesOfListener operation. </summary> <param name="request">Container for the necessary parameters to execute the SetLoadBalancerPoliciesOfListener operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.#ctor"> <summary> Constructs AmazonElasticLoadBalancingClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticLoadBalancingClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.#ctor(Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingConfig)"> <summary> Constructs AmazonElasticLoadBalancingClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonElasticLoadBalancingClient Configuration Object</param> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonElasticLoadBalancingClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticLoadBalancingClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingConfig)"> <summary> Constructs AmazonElasticLoadBalancingClient with AWS Credentials and an AmazonElasticLoadBalancingClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonElasticLoadBalancingClient Configuration Object</param> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonElasticLoadBalancingClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticLoadBalancingClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.#ctor(System.String,System.String,Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingConfig)"> <summary> Constructs AmazonElasticLoadBalancingClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticLoadBalancingClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonElasticLoadBalancingClient Configuration Object</param> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonElasticLoadBalancingClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticLoadBalancingClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.#ctor(System.String,System.String,System.String,Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingConfig)"> <summary> Constructs AmazonElasticLoadBalancingClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticLoadBalancingClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonElasticLoadBalancingClient Configuration Object</param> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.AddTags(Amazon.ElasticLoadBalancing.Model.AddTagsRequest)"> <summary> Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags. <para> Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, <code>AddTags</code> updates its value. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/add-remove-tags.html">Tag Your Load Balancer</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddTags service method.</param> <returns>The response from the AddTags service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicateTagKeysException"> A tag key was specified more than once. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyTagsException"> The quota for the number of tags that can be assigned to a load balancer has been reached. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.AddTagsAsync(Amazon.ElasticLoadBalancing.Model.AddTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTags operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.ApplySecurityGroupsToLoadBalancer(Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest)"> <summary> Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups. <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-security-groups.html#elb-vpc-security-groups">Security Groups for Load Balancers in a VPC</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ApplySecurityGroupsToLoadBalancer service method.</param> <returns>The response from the ApplySecurityGroupsToLoadBalancer service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSecurityGroupException"> One or more of the specified security groups do not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.ApplySecurityGroupsToLoadBalancerAsync(Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ApplySecurityGroupsToLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the ApplySecurityGroupsToLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.AttachLoadBalancerToSubnets(Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest)"> <summary> Adds one or more subnets to the set of configured subnets for the specified load balancer. <para> The load balancer evenly distributes requests across all registered subnets. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-manage-subnets.html">Add or Remove Subnets for Your Load Balancer in a VPC</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachLoadBalancerToSubnets service method.</param> <returns>The response from the AttachLoadBalancerToSubnets service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSubnetException"> The specified VPC has no associated Internet gateway. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.SubnetNotFoundException"> One or more of the specified subnets do not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.AttachLoadBalancerToSubnetsAsync(Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachLoadBalancerToSubnets operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachLoadBalancerToSubnets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.ConfigureHealthCheck(Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest)"> <summary> Specifies the health check settings to use when evaluating the health state of your back-end instances. <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-healthchecks.html">Configure Health Checks</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ConfigureHealthCheck service method.</param> <returns>The response from the ConfigureHealthCheck service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.ConfigureHealthCheckAsync(Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ConfigureHealthCheck operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfigureHealthCheck operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.CreateAppCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest)"> <summary> Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners. <para> This policy is similar to the policy created by <a>CreateLBCookieStickinessPolicy</a>, except that the lifetime of the special Elastic Load Balancing cookie, <code>AWSELB</code>, follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie. </para> <para> If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-sticky-sessions.html#enable-sticky-sessions-application">Application-Controlled Session Stickiness</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateAppCookieStickinessPolicy service method.</param> <returns>The response from the CreateAppCookieStickinessPolicy service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicatePolicyNameException"> A policy with the specified name already exists for this load balancer. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyPoliciesException"> The quota for the number of policies for this load balancer has been reached. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.CreateAppCookieStickinessPolicyAsync(Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAppCookieStickinessPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAppCookieStickinessPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.CreateLBCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest)"> <summary> Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners. <para> When a load balancer implements this policy, the load balancer uses a special cookie to track the back-end server instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm. </para> <para> A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-sticky-sessions.html#enable-sticky-sessions-duration">Duration-Based Session Stickiness</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLBCookieStickinessPolicy service method.</param> <returns>The response from the CreateLBCookieStickinessPolicy service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicatePolicyNameException"> A policy with the specified name already exists for this load balancer. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyPoliciesException"> The quota for the number of policies for this load balancer has been reached. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.CreateLBCookieStickinessPolicyAsync(Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLBCookieStickinessPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLBCookieStickinessPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.CreateLoadBalancer(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest)"> <summary> Creates a load balancer. <para> If the call completes successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The load balancer receives incoming traffic and routes it to the registered instances. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/how-elb-works.html">How Elastic Load Balancing Works</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> <para> You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-limits.html">Elastic Load Balancing Limits</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLoadBalancer service method.</param> <returns>The response from the CreateLoadBalancer service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.CertificateNotFoundException"> The specified SSL ID does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM). </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicateAccessPointNameException"> The specified load balancer name already exists for this account. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicateTagKeysException"> A tag key was specified more than once. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSchemeException"> The specified value for the schema is not valid. You can only specify a scheme for load balancers in a VPC. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSecurityGroupException"> One or more of the specified security groups do not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSubnetException"> The specified VPC has no associated Internet gateway. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.SubnetNotFoundException"> One or more of the specified subnets do not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyAccessPointsException"> The quota for the number of load balancers has been reached. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyTagsException"> The quota for the number of tags that can be assigned to a load balancer has been reached. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.CreateLoadBalancerAsync(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.CreateLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest)"> <summary> Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener. <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/us-add-listener.html">Add a Listener to Your Load Balancer</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLoadBalancerListeners service method.</param> <returns>The response from the CreateLoadBalancerListeners service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.CertificateNotFoundException"> The specified SSL ID does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM). </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicateListenerException"> A listener already exists for the specified <code>LoadBalancerName</code> and <code>LoadBalancerPort</code>, but with a different <code>InstancePort</code>, <code>Protocol</code>, or <code>SSLCertificateId</code>. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.CreateLoadBalancerListenersAsync(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLoadBalancerListeners operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLoadBalancerListeners operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.CreateLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest)"> <summary> Creates a policy with the specified attributes for the specified load balancer. <para> Policies are settings that are saved for your load balancer and that can be applied to the front-end listener or the back-end application server, depending on the policy type. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLoadBalancerPolicy service method.</param> <returns>The response from the CreateLoadBalancerPolicy service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicatePolicyNameException"> A policy with the specified name already exists for this load balancer. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyTypeNotFoundException"> One or more of the specified policy types do not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyPoliciesException"> The quota for the number of policies for this load balancer has been reached. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.CreateLoadBalancerPolicyAsync(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLoadBalancerPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLoadBalancerPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DeleteLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest)"> <summary> Deletes the specified load balancer. <para> If you are attempting to recreate a load balancer, you must reconfigure all settings. The DNS name associated with a deleted load balancer are no longer usable. The name and associated DNS record of the deleted load balancer no longer exist and traffic sent to any of its IP addresses is no longer delivered to back-end instances. </para> <para> If the load balancer does not exist or has already been deleted, the call to <code>DeleteLoadBalancer</code> still succeeds. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoadBalancer service method.</param> <returns>The response from the DeleteLoadBalancer service method, as returned by ElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DeleteLoadBalancerAsync(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DeleteLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest)"> <summary> Deletes the specified listeners from the specified load balancer. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoadBalancerListeners service method.</param> <returns>The response from the DeleteLoadBalancerListeners service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DeleteLoadBalancerListenersAsync(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLoadBalancerListeners operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoadBalancerListeners operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DeleteLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest)"> <summary> Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoadBalancerPolicy service method.</param> <returns>The response from the DeleteLoadBalancerPolicy service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DeleteLoadBalancerPolicyAsync(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLoadBalancerPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoadBalancerPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DeregisterInstancesFromLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest)"> <summary> Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer. <para> You can use <a>DescribeLoadBalancers</a> to verify that the instance is deregistered from the load balancer. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_DeReg_Reg_Instances.html">Deregister and Register Amazon EC2 Instances</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterInstancesFromLoadBalancer service method.</param> <returns>The response from the DeregisterInstancesFromLoadBalancer service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidEndPointException"> The specified endpoint is not valid. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DeregisterInstancesFromLoadBalancerAsync(Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterInstancesFromLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterInstancesFromLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeInstanceHealth(Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest)"> <summary> Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceHealth service method.</param> <returns>The response from the DescribeInstanceHealth service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidEndPointException"> The specified endpoint is not valid. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeInstanceHealthAsync(Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInstanceHealth operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceHealth operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesRequest)"> <summary> Describes the attributes for the specified load balancer. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancerAttributes service method.</param> <returns>The response from the DescribeLoadBalancerAttributes service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributeNotFoundException"> The specified load balancer attribute does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancerAttributesAsync(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancerAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancerAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancerPolicies"> <summary> Describes the specified policies. <para> If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. The names of the sample policies have the <code>ELBSample-</code> prefix. </para> </summary> <returns>The response from the DescribeLoadBalancerPolicies service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"> One or more of the specified policies do not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancerPolicies(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest)"> <summary> Describes the specified policies. <para> If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. The names of the sample policies have the <code>ELBSample-</code> prefix. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancerPolicies service method.</param> <returns>The response from the DescribeLoadBalancerPolicies service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"> One or more of the specified policies do not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancerPoliciesAsync(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancerPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancerPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancerPolicyTypes"> <summary> Describes the specified load balancer policy types. <para> You can use these policy types with <a>CreateLoadBalancerPolicy</a> to create policy configurations for a load balancer. </para> </summary> <returns>The response from the DescribeLoadBalancerPolicyTypes service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyTypeNotFoundException"> One or more of the specified policy types do not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancerPolicyTypes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest)"> <summary> Describes the specified load balancer policy types. <para> You can use these policy types with <a>CreateLoadBalancerPolicy</a> to create policy configurations for a load balancer. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancerPolicyTypes service method.</param> <returns>The response from the DescribeLoadBalancerPolicyTypes service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyTypeNotFoundException"> One or more of the specified policy types do not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancerPolicyTypesAsync(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancerPolicyTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancerPolicyTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancers"> <summary> Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers. </summary> <returns>The response from the DescribeLoadBalancers service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancers(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest)"> <summary> Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancers service method.</param> <returns>The response from the DescribeLoadBalancers service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancersAsync(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancers operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeTags(Amazon.ElasticLoadBalancing.Model.DescribeTagsRequest)"> <summary> Describes the tags associated with the specified load balancers. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags service method.</param> <returns>The response from the DescribeTags service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeTagsAsync(Amazon.ElasticLoadBalancing.Model.DescribeTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DetachLoadBalancerFromSubnets(Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest)"> <summary> Removes the specified subnets from the set of configured subnets for the load balancer. <para> After a subnet is removed, all EC2 instances registered with the load balancer in the removed subnet go into the <code>OutOfService</code> state. Then, the load balancer balances the traffic among the remaining routable subnets. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachLoadBalancerFromSubnets service method.</param> <returns>The response from the DetachLoadBalancerFromSubnets service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DetachLoadBalancerFromSubnetsAsync(Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachLoadBalancerFromSubnets operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachLoadBalancerFromSubnets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DisableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest)"> <summary> Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer. <para> There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the <code>OutOfService</code> state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_ShrinkLBApp04.html">Disable an Availability Zone from a Load-Balanced Application</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DisableAvailabilityZonesForLoadBalancer service method.</param> <returns>The response from the DisableAvailabilityZonesForLoadBalancer service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DisableAvailabilityZonesForLoadBalancerAsync(Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableAvailabilityZonesForLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableAvailabilityZonesForLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EnableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest)"> <summary> Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer. <para> The load balancer evenly distributes requests across all its registered Availability Zones that contain instances. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_AddLBAvailabilityZone.html">Add Availability Zone</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the EnableAvailabilityZonesForLoadBalancer service method.</param> <returns>The response from the EnableAvailabilityZonesForLoadBalancer service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EnableAvailabilityZonesForLoadBalancerAsync(Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableAvailabilityZonesForLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableAvailabilityZonesForLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.ModifyLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest)"> <summary> Modifies the attributes of the specified load balancer. <para> You can modify the load balancer attributes, such as <code>AccessLogs</code>, <code>ConnectionDraining</code>, and <code>CrossZoneLoadBalancing</code> by either enabling or disabling them. Or, you can modify the load balancer attribute <code>ConnectionSettings</code> by specifying an idle connection timeout value for your load balancer. </para> <para> For more information, see the following in the <i>Elastic Load Balancing Developer Guide</i>: </para> <ul> <li><a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#request-routing">Cross-Zone Load Balancing</a></li> <li><a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain">Connection Draining</a></li> <li><a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/access-log-collection.html">Access Logs</a></li> <li><a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#idle-timeout">Idle Connection Timeout</a></li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the ModifyLoadBalancerAttributes service method.</param> <returns>The response from the ModifyLoadBalancerAttributes service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributeNotFoundException"> The specified load balancer attribute does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.ModifyLoadBalancerAttributesAsync(Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyLoadBalancerAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyLoadBalancerAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.RegisterInstancesWithLoadBalancer(Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest)"> <summary> Adds the specified instances to the specified load balancer. <para> The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC. </para> <para> Note that <code>RegisterInstanceWithLoadBalancer</code> completes when the request has been registered. Instance registration takes a little time to complete. To check the state of the registered instances, use <a>DescribeLoadBalancers</a> or <a>DescribeInstanceHealth</a>. </para> <para> After the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in one of the Availability Zones registered for the load balancer is moved to the <code>OutOfService</code> state. If an Availability Zone is added to the load balancer later, any instances registered with the load balancer move to the <code>InService</code> state. </para> <para> If you stop an instance registered with a load balancer and then start it, the IP addresses associated with the instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to the instances. We recommend that you use the following sequence: stop the instance, deregister the instance, start the instance, and then register the instance. To deregister instances from a load balancer, use <a>DeregisterInstancesFromLoadBalancer</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_DeReg_Reg_Instances.html">Deregister and Register EC2 Instances</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterInstancesWithLoadBalancer service method.</param> <returns>The response from the RegisterInstancesWithLoadBalancer service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidEndPointException"> The specified endpoint is not valid. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.RegisterInstancesWithLoadBalancerAsync(Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterInstancesWithLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterInstancesWithLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.RemoveTags(Amazon.ElasticLoadBalancing.Model.RemoveTagsRequest)"> <summary> Removes one or more tags from the specified load balancer. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags service method.</param> <returns>The response from the RemoveTags service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.RemoveTagsAsync(Amazon.ElasticLoadBalancing.Model.RemoveTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTags operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.SetLoadBalancerListenerSSLCertificate(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest)"> <summary> Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port. <para> For more information about updating your SSL certificate, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_UpdatingLoadBalancerSSL.html">Updating an SSL Certificate for a Load Balancer</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetLoadBalancerListenerSSLCertificate service method.</param> <returns>The response from the SetLoadBalancerListenerSSLCertificate service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.CertificateNotFoundException"> The specified SSL ID does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM). </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.ListenerNotFoundException"> The load balancer does not have a listener configured at the specified port. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.SetLoadBalancerListenerSSLCertificateAsync(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetLoadBalancerListenerSSLCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the SetLoadBalancerListenerSSLCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.SetLoadBalancerPoliciesForBackendServer(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest)"> <summary> Replaces the set of policies associated with the specified port on which the back-end server is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the back-end ports; this policy type is composed of multiple public key policies. <para> Each time you use <code>SetLoadBalancerPoliciesForBackendServer</code> to enable the policies, use the <code>PolicyNames</code> parameter to list the policies that you want to enable. </para> <para> You can use <a>DescribeLoadBalancers</a> or <a>DescribeLoadBalancerPolicies</a> to verify that the policy is associated with the back-end server. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetLoadBalancerPoliciesForBackendServer service method.</param> <returns>The response from the SetLoadBalancerPoliciesForBackendServer service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"> One or more of the specified policies do not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.SetLoadBalancerPoliciesForBackendServerAsync(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetLoadBalancerPoliciesForBackendServer operation. </summary> <param name="request">Container for the necessary parameters to execute the SetLoadBalancerPoliciesForBackendServer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.SetLoadBalancerPoliciesOfListener(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest)"> <summary> Associates, updates, or disables a policy with a listener for the specified load balancer. You can associate multiple policies with a listener. </summary> <param name="request">Container for the necessary parameters to execute the SetLoadBalancerPoliciesOfListener service method.</param> <returns>The response from the SetLoadBalancerPoliciesOfListener service method, as returned by ElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.AccessPointNotFoundException"> The specified load balancer does not exist. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> The requested configuration change is not valid. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.ListenerNotFoundException"> The load balancer does not have a listener configured at the specified port. </exception> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"> One or more of the specified policies do not exist. </exception> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.SetLoadBalancerPoliciesOfListenerAsync(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetLoadBalancerPoliciesOfListener operation. </summary> <param name="request">Container for the necessary parameters to execute the SetLoadBalancerPoliciesOfListener operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient"> <summary> Implementation for accessing ElasticMapReduce Amazon Elastic MapReduce (Amazon EMR) is a web service that makes it easy to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several AWS products to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehousing. </summary> </member> <member name="T:Amazon.ElasticMapReduce.IAmazonElasticMapReduce"> <summary> Interface for accessing ElasticMapReduce Amazon Elastic MapReduce (Amazon EMR) is a web service that makes it easy to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several AWS products to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehousing. </summary> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.AddInstanceGroups(Amazon.ElasticMapReduce.Model.AddInstanceGroupsRequest)"> <summary> AddInstanceGroups adds an instance group to a running cluster. </summary> <param name="request">Container for the necessary parameters to execute the AddInstanceGroups service method.</param> <returns>The response from the AddInstanceGroups service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.AddInstanceGroupsAsync(Amazon.ElasticMapReduce.Model.AddInstanceGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddInstanceGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the AddInstanceGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.AddJobFlowSteps(Amazon.ElasticMapReduce.Model.AddJobFlowStepsRequest)"> <summary> AddJobFlowSteps adds new steps to a running job flow. A maximum of 256 steps are allowed in each job flow. <para> If your job flow is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, go to <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/AddMoreThan256Steps.html">Add More than 256 Steps to a Job Flow</a> in the <i>Amazon Elastic MapReduce Developer's Guide</i>. </para> <para> A step specifies the location of a JAR file stored either on the master node of the job flow or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step. </para> <para> Elastic MapReduce executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully. </para> <para> You can only add steps to a job flow that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddJobFlowSteps service method.</param> <returns>The response from the AddJobFlowSteps service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.AddJobFlowStepsAsync(Amazon.ElasticMapReduce.Model.AddJobFlowStepsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddJobFlowSteps operation. </summary> <param name="request">Container for the necessary parameters to execute the AddJobFlowSteps operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.AddTags(Amazon.ElasticMapReduce.Model.AddTagsRequest)"> <summary> Adds tags to an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-plan-tags.html">Tagging Amazon EMR Resources</a>. </summary> <param name="request">Container for the necessary parameters to execute the AddTags service method.</param> <returns>The response from the AddTags service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.AddTagsAsync(Amazon.ElasticMapReduce.Model.AddTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTags operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.DescribeCluster"> <summary> Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see <a>ListSteps</a>. </summary> <returns>The response from the DescribeCluster service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.DescribeCluster(Amazon.ElasticMapReduce.Model.DescribeClusterRequest)"> <summary> Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see <a>ListSteps</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCluster service method.</param> <returns>The response from the DescribeCluster service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.DescribeClusterAsync(Amazon.ElasticMapReduce.Model.DescribeClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.DescribeJobFlows"> <summary> This API is deprecated and will eventually be removed. We recommend you use <a>ListClusters</a>, <a>DescribeCluster</a>, <a>ListSteps</a>, <a>ListInstanceGroups</a> and <a>ListBootstrapActions</a> instead. <para> DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time. </para> <para> Regardless of supplied parameters, only job flows created within the last two months are returned. </para> <para> If no parameters are supplied, then job flows matching either of the following criteria are returned: </para> <ul> <li>Job flows created and completed in the last two weeks</li> <li> Job flows created within the last two months that are in one of the following states: <code>RUNNING</code>, <code>WAITING</code>, <code>SHUTTING_DOWN</code>, <code>STARTING</code> </li> </ul> <para> Amazon Elastic MapReduce can return a maximum of 512 job flow descriptions. </para> </summary> <returns>The response from the DescribeJobFlows service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.DescribeJobFlows(Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest)"> <summary> This API is deprecated and will eventually be removed. We recommend you use <a>ListClusters</a>, <a>DescribeCluster</a>, <a>ListSteps</a>, <a>ListInstanceGroups</a> and <a>ListBootstrapActions</a> instead. <para> DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time. </para> <para> Regardless of supplied parameters, only job flows created within the last two months are returned. </para> <para> If no parameters are supplied, then job flows matching either of the following criteria are returned: </para> <ul> <li>Job flows created and completed in the last two weeks</li> <li> Job flows created within the last two months that are in one of the following states: <code>RUNNING</code>, <code>WAITING</code>, <code>SHUTTING_DOWN</code>, <code>STARTING</code> </li> </ul> <para> Amazon Elastic MapReduce can return a maximum of 512 job flow descriptions. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeJobFlows service method.</param> <returns>The response from the DescribeJobFlows service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.DescribeJobFlowsAsync(Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeJobFlows operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeJobFlows operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.DescribeStep"> <summary> Provides more detail about the cluster step. </summary> <returns>The response from the DescribeStep service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.DescribeStep(Amazon.ElasticMapReduce.Model.DescribeStepRequest)"> <summary> Provides more detail about the cluster step. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStep service method.</param> <returns>The response from the DescribeStep service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.DescribeStepAsync(Amazon.ElasticMapReduce.Model.DescribeStepRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStep operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStep operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ListBootstrapActions"> <summary> Provides information about the bootstrap actions associated with a cluster. </summary> <returns>The response from the ListBootstrapActions service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ListBootstrapActions(Amazon.ElasticMapReduce.Model.ListBootstrapActionsRequest)"> <summary> Provides information about the bootstrap actions associated with a cluster. </summary> <param name="request">Container for the necessary parameters to execute the ListBootstrapActions service method.</param> <returns>The response from the ListBootstrapActions service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ListBootstrapActionsAsync(Amazon.ElasticMapReduce.Model.ListBootstrapActionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListBootstrapActions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListBootstrapActions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ListClusters"> <summary> Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls. </summary> <returns>The response from the ListClusters service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ListClusters(Amazon.ElasticMapReduce.Model.ListClustersRequest)"> <summary> Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls. </summary> <param name="request">Container for the necessary parameters to execute the ListClusters service method.</param> <returns>The response from the ListClusters service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ListClustersAsync(Amazon.ElasticMapReduce.Model.ListClustersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the ListClusters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ListInstanceGroups"> <summary> Provides all available details about the instance groups in a cluster. </summary> <returns>The response from the ListInstanceGroups service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ListInstanceGroups(Amazon.ElasticMapReduce.Model.ListInstanceGroupsRequest)"> <summary> Provides all available details about the instance groups in a cluster. </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceGroups service method.</param> <returns>The response from the ListInstanceGroups service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ListInstanceGroupsAsync(Amazon.ElasticMapReduce.Model.ListInstanceGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListInstanceGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ListInstances"> <summary> Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. For example, this operation indicates when the EC2 instances reach the Ready state, when instances become available to Amazon EMR to use for jobs, and the IP addresses for cluster instances, etc. </summary> <returns>The response from the ListInstances service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ListInstances(Amazon.ElasticMapReduce.Model.ListInstancesRequest)"> <summary> Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. For example, this operation indicates when the EC2 instances reach the Ready state, when instances become available to Amazon EMR to use for jobs, and the IP addresses for cluster instances, etc. </summary> <param name="request">Container for the necessary parameters to execute the ListInstances service method.</param> <returns>The response from the ListInstances service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ListInstancesAsync(Amazon.ElasticMapReduce.Model.ListInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ListInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ListSteps"> <summary> Provides a list of steps for the cluster. </summary> <returns>The response from the ListSteps service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ListSteps(Amazon.ElasticMapReduce.Model.ListStepsRequest)"> <summary> Provides a list of steps for the cluster. </summary> <param name="request">Container for the necessary parameters to execute the ListSteps service method.</param> <returns>The response from the ListSteps service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ListStepsAsync(Amazon.ElasticMapReduce.Model.ListStepsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListSteps operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSteps operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ModifyInstanceGroups(Amazon.ElasticMapReduce.Model.ModifyInstanceGroupsRequest)"> <summary> ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically. </summary> <param name="request">Container for the necessary parameters to execute the ModifyInstanceGroups service method.</param> <returns>The response from the ModifyInstanceGroups service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.ModifyInstanceGroupsAsync(Amazon.ElasticMapReduce.Model.ModifyInstanceGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyInstanceGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyInstanceGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.RemoveTags(Amazon.ElasticMapReduce.Model.RemoveTagsRequest)"> <summary> Removes tags from an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-plan-tags.html">Tagging Amazon EMR Resources</a>. <para> The following example removes the stack tag with value Prod from a cluster: </para> </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags service method.</param> <returns>The response from the RemoveTags service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.RemoveTagsAsync(Amazon.ElasticMapReduce.Model.RemoveTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTags operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.RunJobFlow(Amazon.ElasticMapReduce.Model.RunJobFlowRequest)"> <summary> RunJobFlow creates and starts running a new job flow. The job flow will run the steps specified. Once the job flow completes, the cluster is stopped and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the <a>JobFlowInstancesConfig</a> <code>KeepJobFlowAliveWhenNoSteps</code> parameter is set to <code>TRUE</code>, the job flow will transition to the WAITING state rather than shutting down once the steps have completed. <para> For additional protection, you can set the <a>JobFlowInstancesConfig</a> <code>TerminationProtected</code> parameter to <code>TRUE</code> to lock the job flow and prevent it from being terminated by API call, user intervention, or in the event of a job flow error. </para> <para> A maximum of 256 steps are allowed in each job flow. </para> <para> If your job flow is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, go to <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/AddMoreThan256Steps.html">Add More than 256 Steps to a Job Flow</a> in the <i>Amazon Elastic MapReduce Developer's Guide</i>. </para> <para> For long running job flows, we recommend that you periodically store your results. </para> </summary> <param name="request">Container for the necessary parameters to execute the RunJobFlow service method.</param> <returns>The response from the RunJobFlow service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.RunJobFlowAsync(Amazon.ElasticMapReduce.Model.RunJobFlowRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RunJobFlow operation. </summary> <param name="request">Container for the necessary parameters to execute the RunJobFlow operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.SetTerminationProtection(Amazon.ElasticMapReduce.Model.SetTerminationProtectionRequest)"> <summary> SetTerminationProtection locks a job flow so the Amazon EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection on a job flow is analogous to calling the Amazon EC2 DisableAPITermination API on all of the EC2 instances in a cluster. <para> SetTerminationProtection is used to prevent accidental termination of a job flow and to ensure that in the event of an error, the instances will persist so you can recover any data stored in their ephemeral instance storage. </para> <para> To terminate a job flow that has been locked by setting SetTerminationProtection to <code>true</code>, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to <code>false</code>. </para> <para> For more information, go to <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/UsingEMR_TerminationProtection.html">Protecting a Job Flow from Termination</a> in the <i>Amazon Elastic MapReduce Developer's Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the SetTerminationProtection service method.</param> <returns>The response from the SetTerminationProtection service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.SetTerminationProtectionAsync(Amazon.ElasticMapReduce.Model.SetTerminationProtectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetTerminationProtection operation. </summary> <param name="request">Container for the necessary parameters to execute the SetTerminationProtection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.SetVisibleToAllUsers(Amazon.ElasticMapReduce.Model.SetVisibleToAllUsersRequest)"> <summary> Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified job flows. This action works on running job flows. You can also set the visibility of a job flow when you launch it using the <code>VisibleToAllUsers</code> parameter of <a>RunJobFlow</a>. The SetVisibleToAllUsers action can be called only by an IAM user who created the job flow or the AWS account that owns the job flow. </summary> <param name="request">Container for the necessary parameters to execute the SetVisibleToAllUsers service method.</param> <returns>The response from the SetVisibleToAllUsers service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.SetVisibleToAllUsersAsync(Amazon.ElasticMapReduce.Model.SetVisibleToAllUsersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetVisibleToAllUsers operation. </summary> <param name="request">Container for the necessary parameters to execute the SetVisibleToAllUsers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.TerminateJobFlows(Amazon.ElasticMapReduce.Model.TerminateJobFlowsRequest)"> <summary> TerminateJobFlows shuts a list of job flows down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the job flow is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the job flow was created. <para> The maximum number of JobFlows allowed is 10. The call to TerminateJobFlows is asynchronous. Depending on the configuration of the job flow, it may take up to 5-20 minutes for the job flow to completely terminate and release allocated resources, such as Amazon EC2 instances. </para> </summary> <param name="request">Container for the necessary parameters to execute the TerminateJobFlows service method.</param> <returns>The response from the TerminateJobFlows service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.IAmazonElasticMapReduce.TerminateJobFlowsAsync(Amazon.ElasticMapReduce.Model.TerminateJobFlowsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TerminateJobFlows operation. </summary> <param name="request">Container for the necessary parameters to execute the TerminateJobFlows operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.#ctor"> <summary> Constructs AmazonElasticMapReduceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticMapReduceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.#ctor(Amazon.ElasticMapReduce.AmazonElasticMapReduceConfig)"> <summary> Constructs AmazonElasticMapReduceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonElasticMapReduceClient Configuration Object</param> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonElasticMapReduceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticMapReduceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.ElasticMapReduce.AmazonElasticMapReduceConfig)"> <summary> Constructs AmazonElasticMapReduceClient with AWS Credentials and an AmazonElasticMapReduceClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonElasticMapReduceClient Configuration Object</param> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonElasticMapReduceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticMapReduceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.#ctor(System.String,System.String,Amazon.ElasticMapReduce.AmazonElasticMapReduceConfig)"> <summary> Constructs AmazonElasticMapReduceClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticMapReduceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonElasticMapReduceClient Configuration Object</param> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonElasticMapReduceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticMapReduceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.#ctor(System.String,System.String,System.String,Amazon.ElasticMapReduce.AmazonElasticMapReduceConfig)"> <summary> Constructs AmazonElasticMapReduceClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticMapReduceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonElasticMapReduceClient Configuration Object</param> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.AddInstanceGroups(Amazon.ElasticMapReduce.Model.AddInstanceGroupsRequest)"> <summary> AddInstanceGroups adds an instance group to a running cluster. </summary> <param name="request">Container for the necessary parameters to execute the AddInstanceGroups service method.</param> <returns>The response from the AddInstanceGroups service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.AddInstanceGroupsAsync(Amazon.ElasticMapReduce.Model.AddInstanceGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddInstanceGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the AddInstanceGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.AddJobFlowSteps(Amazon.ElasticMapReduce.Model.AddJobFlowStepsRequest)"> <summary> AddJobFlowSteps adds new steps to a running job flow. A maximum of 256 steps are allowed in each job flow. <para> If your job flow is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, go to <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/AddMoreThan256Steps.html">Add More than 256 Steps to a Job Flow</a> in the <i>Amazon Elastic MapReduce Developer's Guide</i>. </para> <para> A step specifies the location of a JAR file stored either on the master node of the job flow or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step. </para> <para> Elastic MapReduce executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully. </para> <para> You can only add steps to a job flow that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddJobFlowSteps service method.</param> <returns>The response from the AddJobFlowSteps service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.AddJobFlowStepsAsync(Amazon.ElasticMapReduce.Model.AddJobFlowStepsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddJobFlowSteps operation. </summary> <param name="request">Container for the necessary parameters to execute the AddJobFlowSteps operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.AddTags(Amazon.ElasticMapReduce.Model.AddTagsRequest)"> <summary> Adds tags to an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-plan-tags.html">Tagging Amazon EMR Resources</a>. </summary> <param name="request">Container for the necessary parameters to execute the AddTags service method.</param> <returns>The response from the AddTags service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.AddTagsAsync(Amazon.ElasticMapReduce.Model.AddTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTags operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.DescribeCluster"> <summary> Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see <a>ListSteps</a>. </summary> <returns>The response from the DescribeCluster service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.DescribeCluster(Amazon.ElasticMapReduce.Model.DescribeClusterRequest)"> <summary> Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see <a>ListSteps</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCluster service method.</param> <returns>The response from the DescribeCluster service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.DescribeClusterAsync(Amazon.ElasticMapReduce.Model.DescribeClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.DescribeJobFlows"> <summary> This API is deprecated and will eventually be removed. We recommend you use <a>ListClusters</a>, <a>DescribeCluster</a>, <a>ListSteps</a>, <a>ListInstanceGroups</a> and <a>ListBootstrapActions</a> instead. <para> DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time. </para> <para> Regardless of supplied parameters, only job flows created within the last two months are returned. </para> <para> If no parameters are supplied, then job flows matching either of the following criteria are returned: </para> <ul> <li>Job flows created and completed in the last two weeks</li> <li> Job flows created within the last two months that are in one of the following states: <code>RUNNING</code>, <code>WAITING</code>, <code>SHUTTING_DOWN</code>, <code>STARTING</code> </li> </ul> <para> Amazon Elastic MapReduce can return a maximum of 512 job flow descriptions. </para> </summary> <returns>The response from the DescribeJobFlows service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.DescribeJobFlows(Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest)"> <summary> This API is deprecated and will eventually be removed. We recommend you use <a>ListClusters</a>, <a>DescribeCluster</a>, <a>ListSteps</a>, <a>ListInstanceGroups</a> and <a>ListBootstrapActions</a> instead. <para> DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time. </para> <para> Regardless of supplied parameters, only job flows created within the last two months are returned. </para> <para> If no parameters are supplied, then job flows matching either of the following criteria are returned: </para> <ul> <li>Job flows created and completed in the last two weeks</li> <li> Job flows created within the last two months that are in one of the following states: <code>RUNNING</code>, <code>WAITING</code>, <code>SHUTTING_DOWN</code>, <code>STARTING</code> </li> </ul> <para> Amazon Elastic MapReduce can return a maximum of 512 job flow descriptions. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeJobFlows service method.</param> <returns>The response from the DescribeJobFlows service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.DescribeJobFlowsAsync(Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeJobFlows operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeJobFlows operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.DescribeStep"> <summary> Provides more detail about the cluster step. </summary> <returns>The response from the DescribeStep service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.DescribeStep(Amazon.ElasticMapReduce.Model.DescribeStepRequest)"> <summary> Provides more detail about the cluster step. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStep service method.</param> <returns>The response from the DescribeStep service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.DescribeStepAsync(Amazon.ElasticMapReduce.Model.DescribeStepRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStep operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStep operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ListBootstrapActions"> <summary> Provides information about the bootstrap actions associated with a cluster. </summary> <returns>The response from the ListBootstrapActions service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ListBootstrapActions(Amazon.ElasticMapReduce.Model.ListBootstrapActionsRequest)"> <summary> Provides information about the bootstrap actions associated with a cluster. </summary> <param name="request">Container for the necessary parameters to execute the ListBootstrapActions service method.</param> <returns>The response from the ListBootstrapActions service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ListBootstrapActionsAsync(Amazon.ElasticMapReduce.Model.ListBootstrapActionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListBootstrapActions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListBootstrapActions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ListClusters"> <summary> Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls. </summary> <returns>The response from the ListClusters service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ListClusters(Amazon.ElasticMapReduce.Model.ListClustersRequest)"> <summary> Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls. </summary> <param name="request">Container for the necessary parameters to execute the ListClusters service method.</param> <returns>The response from the ListClusters service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ListClustersAsync(Amazon.ElasticMapReduce.Model.ListClustersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the ListClusters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ListInstanceGroups"> <summary> Provides all available details about the instance groups in a cluster. </summary> <returns>The response from the ListInstanceGroups service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ListInstanceGroups(Amazon.ElasticMapReduce.Model.ListInstanceGroupsRequest)"> <summary> Provides all available details about the instance groups in a cluster. </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceGroups service method.</param> <returns>The response from the ListInstanceGroups service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ListInstanceGroupsAsync(Amazon.ElasticMapReduce.Model.ListInstanceGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListInstanceGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ListInstances"> <summary> Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. For example, this operation indicates when the EC2 instances reach the Ready state, when instances become available to Amazon EMR to use for jobs, and the IP addresses for cluster instances, etc. </summary> <returns>The response from the ListInstances service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ListInstances(Amazon.ElasticMapReduce.Model.ListInstancesRequest)"> <summary> Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. For example, this operation indicates when the EC2 instances reach the Ready state, when instances become available to Amazon EMR to use for jobs, and the IP addresses for cluster instances, etc. </summary> <param name="request">Container for the necessary parameters to execute the ListInstances service method.</param> <returns>The response from the ListInstances service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ListInstancesAsync(Amazon.ElasticMapReduce.Model.ListInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ListInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ListSteps"> <summary> Provides a list of steps for the cluster. </summary> <returns>The response from the ListSteps service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ListSteps(Amazon.ElasticMapReduce.Model.ListStepsRequest)"> <summary> Provides a list of steps for the cluster. </summary> <param name="request">Container for the necessary parameters to execute the ListSteps service method.</param> <returns>The response from the ListSteps service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ListStepsAsync(Amazon.ElasticMapReduce.Model.ListStepsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListSteps operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSteps operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ModifyInstanceGroups(Amazon.ElasticMapReduce.Model.ModifyInstanceGroupsRequest)"> <summary> ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically. </summary> <param name="request">Container for the necessary parameters to execute the ModifyInstanceGroups service method.</param> <returns>The response from the ModifyInstanceGroups service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.ModifyInstanceGroupsAsync(Amazon.ElasticMapReduce.Model.ModifyInstanceGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyInstanceGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyInstanceGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.RemoveTags(Amazon.ElasticMapReduce.Model.RemoveTagsRequest)"> <summary> Removes tags from an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-plan-tags.html">Tagging Amazon EMR Resources</a>. <para> The following example removes the stack tag with value Prod from a cluster: </para> </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags service method.</param> <returns>The response from the RemoveTags service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerException"> This exception occurs when there is an internal failure in the EMR service. </exception> <exception cref="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> This exception occurs when there is something wrong with user input. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.RemoveTagsAsync(Amazon.ElasticMapReduce.Model.RemoveTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTags operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.RunJobFlow(Amazon.ElasticMapReduce.Model.RunJobFlowRequest)"> <summary> RunJobFlow creates and starts running a new job flow. The job flow will run the steps specified. Once the job flow completes, the cluster is stopped and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the <a>JobFlowInstancesConfig</a> <code>KeepJobFlowAliveWhenNoSteps</code> parameter is set to <code>TRUE</code>, the job flow will transition to the WAITING state rather than shutting down once the steps have completed. <para> For additional protection, you can set the <a>JobFlowInstancesConfig</a> <code>TerminationProtected</code> parameter to <code>TRUE</code> to lock the job flow and prevent it from being terminated by API call, user intervention, or in the event of a job flow error. </para> <para> A maximum of 256 steps are allowed in each job flow. </para> <para> If your job flow is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, go to <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/AddMoreThan256Steps.html">Add More than 256 Steps to a Job Flow</a> in the <i>Amazon Elastic MapReduce Developer's Guide</i>. </para> <para> For long running job flows, we recommend that you periodically store your results. </para> </summary> <param name="request">Container for the necessary parameters to execute the RunJobFlow service method.</param> <returns>The response from the RunJobFlow service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.RunJobFlowAsync(Amazon.ElasticMapReduce.Model.RunJobFlowRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RunJobFlow operation. </summary> <param name="request">Container for the necessary parameters to execute the RunJobFlow operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.SetTerminationProtection(Amazon.ElasticMapReduce.Model.SetTerminationProtectionRequest)"> <summary> SetTerminationProtection locks a job flow so the Amazon EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection on a job flow is analogous to calling the Amazon EC2 DisableAPITermination API on all of the EC2 instances in a cluster. <para> SetTerminationProtection is used to prevent accidental termination of a job flow and to ensure that in the event of an error, the instances will persist so you can recover any data stored in their ephemeral instance storage. </para> <para> To terminate a job flow that has been locked by setting SetTerminationProtection to <code>true</code>, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to <code>false</code>. </para> <para> For more information, go to <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/UsingEMR_TerminationProtection.html">Protecting a Job Flow from Termination</a> in the <i>Amazon Elastic MapReduce Developer's Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the SetTerminationProtection service method.</param> <returns>The response from the SetTerminationProtection service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.SetTerminationProtectionAsync(Amazon.ElasticMapReduce.Model.SetTerminationProtectionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetTerminationProtection operation. </summary> <param name="request">Container for the necessary parameters to execute the SetTerminationProtection operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.SetVisibleToAllUsers(Amazon.ElasticMapReduce.Model.SetVisibleToAllUsersRequest)"> <summary> Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified job flows. This action works on running job flows. You can also set the visibility of a job flow when you launch it using the <code>VisibleToAllUsers</code> parameter of <a>RunJobFlow</a>. The SetVisibleToAllUsers action can be called only by an IAM user who created the job flow or the AWS account that owns the job flow. </summary> <param name="request">Container for the necessary parameters to execute the SetVisibleToAllUsers service method.</param> <returns>The response from the SetVisibleToAllUsers service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.SetVisibleToAllUsersAsync(Amazon.ElasticMapReduce.Model.SetVisibleToAllUsersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetVisibleToAllUsers operation. </summary> <param name="request">Container for the necessary parameters to execute the SetVisibleToAllUsers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.TerminateJobFlows(Amazon.ElasticMapReduce.Model.TerminateJobFlowsRequest)"> <summary> TerminateJobFlows shuts a list of job flows down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the job flow is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the job flow was created. <para> The maximum number of JobFlows allowed is 10. The call to TerminateJobFlows is asynchronous. Depending on the configuration of the job flow, it may take up to 5-20 minutes for the job flow to completely terminate and release allocated resources, such as Amazon EC2 instances. </para> </summary> <param name="request">Container for the necessary parameters to execute the TerminateJobFlows service method.</param> <returns>The response from the TerminateJobFlows service method, as returned by ElasticMapReduce.</returns> <exception cref="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> Indicates that an error occurred while processing the request and that the request was not completed. </exception> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.TerminateJobFlowsAsync(Amazon.ElasticMapReduce.Model.TerminateJobFlowsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TerminateJobFlows operation. </summary> <param name="request">Container for the necessary parameters to execute the TerminateJobFlows operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient"> <summary> Implementation for accessing ElasticTranscoder AWS Elastic Transcoder Service <para> The AWS Elastic Transcoder Service. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.IAmazonElasticTranscoder"> <summary> Interface for accessing ElasticTranscoder AWS Elastic Transcoder Service <para> The AWS Elastic Transcoder Service. </para> </summary> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.CancelJob(Amazon.ElasticTranscoder.Model.CancelJobRequest)"> <summary> The CancelJob operation cancels an unfinished job. <note>You can only cancel a job that has a status of <code>Submitted</code>. To prevent a pipeline from starting to process a job while you're getting the job identifier, use <a>UpdatePipelineStatus</a> to temporarily pause the pipeline.</note> </summary> <param name="request">Container for the necessary parameters to execute the CancelJob service method.</param> <returns>The response from the CancelJob service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceInUseException"> The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.CancelJobAsync(Amazon.ElasticTranscoder.Model.CancelJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelJob operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.CreateJob(Amazon.ElasticTranscoder.Model.CreateJobRequest)"> <summary> When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created. <para> If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console). </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateJob service method.</param> <returns>The response from the CreateJob service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.LimitExceededException"> Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.CreateJobAsync(Amazon.ElasticTranscoder.Model.CreateJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateJob operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.CreatePipeline(Amazon.ElasticTranscoder.Model.CreatePipelineRequest)"> <summary> The CreatePipeline operation creates a pipeline with settings that you specify. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline service method.</param> <returns>The response from the CreatePipeline service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.LimitExceededException"> Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.CreatePipelineAsync(Amazon.ElasticTranscoder.Model.CreatePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.CreatePreset(Amazon.ElasticTranscoder.Model.CreatePresetRequest)"> <summary> The CreatePreset operation creates a preset with settings that you specify. <important>Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (<code>ValidationException</code>) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces.</important> <para> Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication <i>Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreatePreset service method.</param> <returns>The response from the CreatePreset service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.LimitExceededException"> Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.CreatePresetAsync(Amazon.ElasticTranscoder.Model.CreatePresetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePreset operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePreset operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.DeletePipeline(Amazon.ElasticTranscoder.Model.DeletePipelineRequest)"> <summary> The DeletePipeline operation removes a pipeline. <para> You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, <code>DeletePipeline</code> returns an error. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline service method.</param> <returns>The response from the DeletePipeline service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceInUseException"> The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.DeletePipelineAsync(Amazon.ElasticTranscoder.Model.DeletePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.DeletePreset(Amazon.ElasticTranscoder.Model.DeletePresetRequest)"> <summary> The DeletePreset operation removes a preset that you've added in an AWS region. <note> <para> You can't delete the default presets that are included with Elastic Transcoder. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DeletePreset service method.</param> <returns>The response from the DeletePreset service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.DeletePresetAsync(Amazon.ElasticTranscoder.Model.DeletePresetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePreset operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePreset operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.ListJobsByPipeline(Amazon.ElasticTranscoder.Model.ListJobsByPipelineRequest)"> <summary> The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline. <para> Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListJobsByPipeline service method.</param> <returns>The response from the ListJobsByPipeline service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.ListJobsByPipelineAsync(Amazon.ElasticTranscoder.Model.ListJobsByPipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListJobsByPipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the ListJobsByPipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.ListJobsByStatus(Amazon.ElasticTranscoder.Model.ListJobsByStatusRequest)"> <summary> The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria. </summary> <param name="request">Container for the necessary parameters to execute the ListJobsByStatus service method.</param> <returns>The response from the ListJobsByStatus service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.ListJobsByStatusAsync(Amazon.ElasticTranscoder.Model.ListJobsByStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListJobsByStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the ListJobsByStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.ListPipelines"> <summary> The ListPipelines operation gets a list of the pipelines associated with the current AWS account. </summary> <returns>The response from the ListPipelines service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.ListPipelines(Amazon.ElasticTranscoder.Model.ListPipelinesRequest)"> <summary> The ListPipelines operation gets a list of the pipelines associated with the current AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines service method.</param> <returns>The response from the ListPipelines service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.ListPipelinesAsync(Amazon.ElasticTranscoder.Model.ListPipelinesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListPipelines operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.ListPresets"> <summary> The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region. </summary> <returns>The response from the ListPresets service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.ListPresets(Amazon.ElasticTranscoder.Model.ListPresetsRequest)"> <summary> The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region. </summary> <param name="request">Container for the necessary parameters to execute the ListPresets service method.</param> <returns>The response from the ListPresets service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.ListPresetsAsync(Amazon.ElasticTranscoder.Model.ListPresetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListPresets operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPresets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.ReadJob(Amazon.ElasticTranscoder.Model.ReadJobRequest)"> <summary> The ReadJob operation returns detailed information about a job. </summary> <param name="request">Container for the necessary parameters to execute the ReadJob service method.</param> <returns>The response from the ReadJob service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.ReadJobAsync(Amazon.ElasticTranscoder.Model.ReadJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReadJob operation. </summary> <param name="request">Container for the necessary parameters to execute the ReadJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.ReadPipeline(Amazon.ElasticTranscoder.Model.ReadPipelineRequest)"> <summary> The ReadPipeline operation gets detailed information about a pipeline. </summary> <param name="request">Container for the necessary parameters to execute the ReadPipeline service method.</param> <returns>The response from the ReadPipeline service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.ReadPipelineAsync(Amazon.ElasticTranscoder.Model.ReadPipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReadPipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the ReadPipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.ReadPreset(Amazon.ElasticTranscoder.Model.ReadPresetRequest)"> <summary> The ReadPreset operation gets detailed information about a preset. </summary> <param name="request">Container for the necessary parameters to execute the ReadPreset service method.</param> <returns>The response from the ReadPreset service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.ReadPresetAsync(Amazon.ElasticTranscoder.Model.ReadPresetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReadPreset operation. </summary> <param name="request">Container for the necessary parameters to execute the ReadPreset operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.TestRole(Amazon.ElasticTranscoder.Model.TestRoleRequest)"> <summary> The TestRole operation tests the IAM role used to create the pipeline. <para> The <code>TestRole</code> action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify. </para> </summary> <param name="request">Container for the necessary parameters to execute the TestRole service method.</param> <returns>The response from the TestRole service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.TestRoleAsync(Amazon.ElasticTranscoder.Model.TestRoleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TestRole operation. </summary> <param name="request">Container for the necessary parameters to execute the TestRole operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.UpdatePipeline(Amazon.ElasticTranscoder.Model.UpdatePipelineRequest)"> <summary> Use the <code>UpdatePipeline</code> operation to update settings for a pipeline. <important>When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings. </important> </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipeline service method.</param> <returns>The response from the UpdatePipeline service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceInUseException"> The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.UpdatePipelineAsync(Amazon.ElasticTranscoder.Model.UpdatePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.UpdatePipelineNotifications(Amazon.ElasticTranscoder.Model.UpdatePipelineNotificationsRequest)"> <summary> With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline. <para> When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipelineNotifications service method.</param> <returns>The response from the UpdatePipelineNotifications service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceInUseException"> The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.UpdatePipelineNotificationsAsync(Amazon.ElasticTranscoder.Model.UpdatePipelineNotificationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdatePipelineNotifications operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipelineNotifications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.UpdatePipelineStatus(Amazon.ElasticTranscoder.Model.UpdatePipelineStatusRequest)"> <summary> The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs. <para> Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a <a>CancelJob</a> request. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipelineStatus service method.</param> <returns>The response from the UpdatePipelineStatus service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceInUseException"> The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.IAmazonElasticTranscoder.UpdatePipelineStatusAsync(Amazon.ElasticTranscoder.Model.UpdatePipelineStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdatePipelineStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipelineStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.#ctor"> <summary> Constructs AmazonElasticTranscoderClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticTranscoderClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.#ctor(Amazon.ElasticTranscoder.AmazonElasticTranscoderConfig)"> <summary> Constructs AmazonElasticTranscoderClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonElasticTranscoderClient Configuration Object</param> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonElasticTranscoderClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticTranscoderClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.ElasticTranscoder.AmazonElasticTranscoderConfig)"> <summary> Constructs AmazonElasticTranscoderClient with AWS Credentials and an AmazonElasticTranscoderClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonElasticTranscoderClient Configuration Object</param> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonElasticTranscoderClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticTranscoderClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.#ctor(System.String,System.String,Amazon.ElasticTranscoder.AmazonElasticTranscoderConfig)"> <summary> Constructs AmazonElasticTranscoderClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticTranscoderClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonElasticTranscoderClient Configuration Object</param> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonElasticTranscoderClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonElasticTranscoderClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.#ctor(System.String,System.String,System.String,Amazon.ElasticTranscoder.AmazonElasticTranscoderConfig)"> <summary> Constructs AmazonElasticTranscoderClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticTranscoderClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonElasticTranscoderClient Configuration Object</param> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.CancelJob(Amazon.ElasticTranscoder.Model.CancelJobRequest)"> <summary> The CancelJob operation cancels an unfinished job. <note>You can only cancel a job that has a status of <code>Submitted</code>. To prevent a pipeline from starting to process a job while you're getting the job identifier, use <a>UpdatePipelineStatus</a> to temporarily pause the pipeline.</note> </summary> <param name="request">Container for the necessary parameters to execute the CancelJob service method.</param> <returns>The response from the CancelJob service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceInUseException"> The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.CancelJobAsync(Amazon.ElasticTranscoder.Model.CancelJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelJob operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.CreateJob(Amazon.ElasticTranscoder.Model.CreateJobRequest)"> <summary> When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created. <para> If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console). </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateJob service method.</param> <returns>The response from the CreateJob service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.LimitExceededException"> Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.CreateJobAsync(Amazon.ElasticTranscoder.Model.CreateJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateJob operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.CreatePipeline(Amazon.ElasticTranscoder.Model.CreatePipelineRequest)"> <summary> The CreatePipeline operation creates a pipeline with settings that you specify. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline service method.</param> <returns>The response from the CreatePipeline service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.LimitExceededException"> Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.CreatePipelineAsync(Amazon.ElasticTranscoder.Model.CreatePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.CreatePreset(Amazon.ElasticTranscoder.Model.CreatePresetRequest)"> <summary> The CreatePreset operation creates a preset with settings that you specify. <important>Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (<code>ValidationException</code>) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces.</important> <para> Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication <i>Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreatePreset service method.</param> <returns>The response from the CreatePreset service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.LimitExceededException"> Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.CreatePresetAsync(Amazon.ElasticTranscoder.Model.CreatePresetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePreset operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePreset operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.DeletePipeline(Amazon.ElasticTranscoder.Model.DeletePipelineRequest)"> <summary> The DeletePipeline operation removes a pipeline. <para> You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, <code>DeletePipeline</code> returns an error. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline service method.</param> <returns>The response from the DeletePipeline service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceInUseException"> The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.DeletePipelineAsync(Amazon.ElasticTranscoder.Model.DeletePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.DeletePreset(Amazon.ElasticTranscoder.Model.DeletePresetRequest)"> <summary> The DeletePreset operation removes a preset that you've added in an AWS region. <note> <para> You can't delete the default presets that are included with Elastic Transcoder. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DeletePreset service method.</param> <returns>The response from the DeletePreset service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.DeletePresetAsync(Amazon.ElasticTranscoder.Model.DeletePresetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePreset operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePreset operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.ListJobsByPipeline(Amazon.ElasticTranscoder.Model.ListJobsByPipelineRequest)"> <summary> The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline. <para> Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListJobsByPipeline service method.</param> <returns>The response from the ListJobsByPipeline service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.ListJobsByPipelineAsync(Amazon.ElasticTranscoder.Model.ListJobsByPipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListJobsByPipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the ListJobsByPipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.ListJobsByStatus(Amazon.ElasticTranscoder.Model.ListJobsByStatusRequest)"> <summary> The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria. </summary> <param name="request">Container for the necessary parameters to execute the ListJobsByStatus service method.</param> <returns>The response from the ListJobsByStatus service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.ListJobsByStatusAsync(Amazon.ElasticTranscoder.Model.ListJobsByStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListJobsByStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the ListJobsByStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.ListPipelines"> <summary> The ListPipelines operation gets a list of the pipelines associated with the current AWS account. </summary> <returns>The response from the ListPipelines service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.ListPipelines(Amazon.ElasticTranscoder.Model.ListPipelinesRequest)"> <summary> The ListPipelines operation gets a list of the pipelines associated with the current AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines service method.</param> <returns>The response from the ListPipelines service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.ListPipelinesAsync(Amazon.ElasticTranscoder.Model.ListPipelinesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListPipelines operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.ListPresets"> <summary> The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region. </summary> <returns>The response from the ListPresets service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.ListPresets(Amazon.ElasticTranscoder.Model.ListPresetsRequest)"> <summary> The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region. </summary> <param name="request">Container for the necessary parameters to execute the ListPresets service method.</param> <returns>The response from the ListPresets service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.ListPresetsAsync(Amazon.ElasticTranscoder.Model.ListPresetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListPresets operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPresets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.ReadJob(Amazon.ElasticTranscoder.Model.ReadJobRequest)"> <summary> The ReadJob operation returns detailed information about a job. </summary> <param name="request">Container for the necessary parameters to execute the ReadJob service method.</param> <returns>The response from the ReadJob service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.ReadJobAsync(Amazon.ElasticTranscoder.Model.ReadJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReadJob operation. </summary> <param name="request">Container for the necessary parameters to execute the ReadJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.ReadPipeline(Amazon.ElasticTranscoder.Model.ReadPipelineRequest)"> <summary> The ReadPipeline operation gets detailed information about a pipeline. </summary> <param name="request">Container for the necessary parameters to execute the ReadPipeline service method.</param> <returns>The response from the ReadPipeline service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.ReadPipelineAsync(Amazon.ElasticTranscoder.Model.ReadPipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReadPipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the ReadPipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.ReadPreset(Amazon.ElasticTranscoder.Model.ReadPresetRequest)"> <summary> The ReadPreset operation gets detailed information about a preset. </summary> <param name="request">Container for the necessary parameters to execute the ReadPreset service method.</param> <returns>The response from the ReadPreset service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.ReadPresetAsync(Amazon.ElasticTranscoder.Model.ReadPresetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReadPreset operation. </summary> <param name="request">Container for the necessary parameters to execute the ReadPreset operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.TestRole(Amazon.ElasticTranscoder.Model.TestRoleRequest)"> <summary> The TestRole operation tests the IAM role used to create the pipeline. <para> The <code>TestRole</code> action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify. </para> </summary> <param name="request">Container for the necessary parameters to execute the TestRole service method.</param> <returns>The response from the TestRole service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.TestRoleAsync(Amazon.ElasticTranscoder.Model.TestRoleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TestRole operation. </summary> <param name="request">Container for the necessary parameters to execute the TestRole operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.UpdatePipeline(Amazon.ElasticTranscoder.Model.UpdatePipelineRequest)"> <summary> Use the <code>UpdatePipeline</code> operation to update settings for a pipeline. <important>When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings. </important> </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipeline service method.</param> <returns>The response from the UpdatePipeline service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceInUseException"> The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.UpdatePipelineAsync(Amazon.ElasticTranscoder.Model.UpdatePipelineRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipeline operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.UpdatePipelineNotifications(Amazon.ElasticTranscoder.Model.UpdatePipelineNotificationsRequest)"> <summary> With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline. <para> When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipelineNotifications service method.</param> <returns>The response from the UpdatePipelineNotifications service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceInUseException"> The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.UpdatePipelineNotificationsAsync(Amazon.ElasticTranscoder.Model.UpdatePipelineNotificationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdatePipelineNotifications operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipelineNotifications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.UpdatePipelineStatus(Amazon.ElasticTranscoder.Model.UpdatePipelineStatusRequest)"> <summary> The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs. <para> Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a <a>CancelJob</a> request. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipelineStatus service method.</param> <returns>The response from the UpdatePipelineStatus service method, as returned by ElasticTranscoder.</returns> <exception cref="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> General authentication failure. The request was not signed correctly. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> Elastic Transcoder encountered an unexpected exception while trying to fulfill the request. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceInUseException"> The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created. </exception> <exception cref="T:Amazon.ElasticTranscoder.Model.ValidationException"> One or more required parameter values were not provided in the request. </exception> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.UpdatePipelineStatusAsync(Amazon.ElasticTranscoder.Model.UpdatePipelineStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdatePipelineStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipelineStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.Glacier.AmazonGlacierClient"> <summary> Implementation for accessing Glacier Amazon Glacier is a storage solution for "cold data." <para> Amazon Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Amazon Glacier, customers can store their data cost effectively for months, years, or decades. Amazon Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations. </para> <para> Amazon Glacier is a great storage choice when low storage cost is paramount, your data is rarely retrieved, and retrieval latency of several hours is acceptable. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, go to <a href="http://aws.amazon.com/s3/">Amazon Simple Storage Service (Amazon S3)</a>. </para> <para> You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Amazon Glacier. </para> <para> If you are a first-time user of Amazon Glacier, we recommend that you begin by reading the following sections in the <i>Amazon Glacier Developer Guide</i>: </para> <ul> <li> <para> <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/introduction.html">What is Amazon Glacier</a> - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service. </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/amazon-glacier-getting-started.html">Getting Started with Amazon Glacier</a> - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives. </para> </li> </ul> </summary> <summary> Implementation for accessing AmazonGlacier. <para>Amazon Glacier is a storage solution for "cold data."</para> <para>Amazon Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Amazon Glacier, customers can store their data cost effectively for months, years, or decades. Amazon Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.</para> <para>Amazon Glacier is a great storage choice when low storage cost is paramount, your data is rarely retrieved, and retrieval latency of several hours is acceptable. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, go to Amazon Simple Storage Service (Amazon S3).</para> <para>You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Amazon Glacier. </para> <para>If you are a first-time user of Amazon Glacier, we recommend that you begin by reading the following sections in the <i>Amazon Glacier Developer Guide</i> :</para> <ul> <li> <para> What is Amazon Glacier - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.</para> </li> <li> <para> Getting Started with Amazon Glacier - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives.</para> </li> </ul> </summary> </member> <member name="T:Amazon.Glacier.IAmazonGlacier"> <summary> Interface for accessing Glacier Amazon Glacier is a storage solution for "cold data." <para> Amazon Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Amazon Glacier, customers can store their data cost effectively for months, years, or decades. Amazon Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations. </para> <para> Amazon Glacier is a great storage choice when low storage cost is paramount, your data is rarely retrieved, and retrieval latency of several hours is acceptable. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, go to <a href="http://aws.amazon.com/s3/">Amazon Simple Storage Service (Amazon S3)</a>. </para> <para> You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Amazon Glacier. </para> <para> If you are a first-time user of Amazon Glacier, we recommend that you begin by reading the following sections in the <i>Amazon Glacier Developer Guide</i>: </para> <ul> <li> <para> <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/introduction.html">What is Amazon Glacier</a> - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service. </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/amazon-glacier-getting-started.html">Getting Started with Amazon Glacier</a> - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives. </para> </li> </ul> </summary> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.AbortMultipartUpload(Amazon.Glacier.Model.AbortMultipartUploadRequest)"> <summary> This operation aborts a multipart upload identified by the upload ID. <para> After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see <a>UploadMultipartPart</a> and <a>CompleteMultipartUpload</a>. </para> <para> This operation is idempotent. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html">Working with Archives in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html">Abort Multipart Upload</a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AbortMultipartUpload service method.</param> <returns>The response from the AbortMultipartUpload service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.AbortMultipartUploadAsync(Amazon.Glacier.Model.AbortMultipartUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AbortMultipartUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the AbortMultipartUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.AbortVaultLock(Amazon.Glacier.Model.AbortVaultLockRequest)"> <summary> This operation aborts the vault locking process if the vault lock is not in the <code>Locked</code> state. If the vault lock is in the <code>Locked</code> state when this operation is requested, the operation returns an <code>AccessDeniedException</code> error. Aborting the vault locking process removes the vault lock policy from the specified vault. <para> A vault lock is put into the <code>InProgress</code> state by calling <a>InitiateVaultLock</a>. A vault lock is put into the <code>Locked</code> state by calling <a>CompleteVaultLock</a>. You can get the state of a vault lock by calling <a>GetVaultLock</a>. For more information about the vault locking process, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html">Amazon Glacier Vault Lock</a>. For more information about vault lock policies, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html">Amazon Glacier Access Control with Vault Lock Policies</a>. </para> <para> This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the <code>InProgress</code> state or if there is no policy associated with the vault. </para> </summary> <param name="request">Container for the necessary parameters to execute the AbortVaultLock service method.</param> <returns>The response from the AbortVaultLock service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.AbortVaultLockAsync(Amazon.Glacier.Model.AbortVaultLockRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AbortVaultLock operation. </summary> <param name="request">Container for the necessary parameters to execute the AbortVaultLock operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.AddTagsToVault(Amazon.Glacier.Model.AddTagsToVaultRequest)"> <summary> This operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the tag limit for the vault to be exceeded, the operation throws the <code>LimitExceededException</code> error. If a tag already exists on the vault under a specified key, the existing key value will be overwritten. For more information about tags, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html">Tagging Amazon Glacier Resources</a>. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToVault service method.</param> <returns>The response from the AddTagsToVault service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.LimitExceededException"> Returned if the request results in a vault or account limit being exceeded. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.AddTagsToVaultAsync(Amazon.Glacier.Model.AddTagsToVaultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTagsToVault operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToVault operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.CompleteMultipartUpload(Amazon.Glacier.Model.CompleteMultipartUploadRequest)"> <summary> You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see <a>InitiateJob</a>. <para> In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html">Computing Checksums</a>. On the server side, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The <a>ListParts</a> operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue. </para> <para> Additionally, Amazon Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Amazon Glacier returns an error and the operation fails. </para> <para> Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html">Uploading Large Archives in Parts (Multipart Upload)</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-complete-upload.html">Complete Multipart Upload</a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CompleteMultipartUpload service method.</param> <returns>The response from the CompleteMultipartUpload service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.CompleteMultipartUploadAsync(Amazon.Glacier.Model.CompleteMultipartUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CompleteMultipartUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the CompleteMultipartUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.CompleteVaultLock(Amazon.Glacier.Model.CompleteVaultLockRequest)"> <summary> This operation completes the vault locking process by transitioning the vault lock from the <code>InProgress</code> state to the <code>Locked</code> state, which causes the vault lock policy to become unchangeable. A vault lock is put into the <code>InProgress</code> state by calling <a>InitiateVaultLock</a>. You can obtain the state of the vault lock by calling <a>GetVaultLock</a>. For more information about the vault locking process, <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html">Amazon Glacier Vault Lock</a>. <para> This operation is idempotent. This request is always successful if the vault lock is in the <code>Locked</code> state and the provided lock ID matches the lock ID originally used to lock the vault. </para> <para> If an invalid lock ID is passed in the request when the vault lock is in the <code>Locked</code> state, the operation returns an <code>AccessDeniedException</code> error. If an invalid lock ID is passed in the request when the vault lock is in the <code>InProgress</code> state, the operation throws an <code>InvalidParameter</code> error. </para> </summary> <param name="request">Container for the necessary parameters to execute the CompleteVaultLock service method.</param> <returns>The response from the CompleteVaultLock service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.CompleteVaultLockAsync(Amazon.Glacier.Model.CompleteVaultLockRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CompleteVaultLock operation. </summary> <param name="request">Container for the necessary parameters to execute the CompleteVaultLock operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.CreateVault(Amazon.Glacier.Model.CreateVaultRequest)"> <summary> This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon Glacier. <para> You must use the following guidelines when naming a vault. </para> <para> <ul> <li> <para> Names can be between 1 and 255 characters long. </para> </li> <li> <para> Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period). </para> </li> </ul> </para> <para> This operation is idempotent. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/creating-vaults.html">Creating a Vault in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-put.html">Create Vault </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVault service method.</param> <returns>The response from the CreateVault service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.LimitExceededException"> Returned if the request results in a vault or account limit being exceeded. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.CreateVaultAsync(Amazon.Glacier.Model.CreateVaultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVault operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVault operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.DeleteArchive(Amazon.Glacier.Model.DeleteArchiveRequest)"> <summary> This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios: <ul> <li>If the archive retrieval job is actively preparing the data for download when Amazon Glacier receives the delete archive request, the archival retrieval operation might fail. </li> <li>If the archive retrieval job has successfully prepared the archive for download when Amazon Glacier receives the delete archive request, you will be able to download the output. </li> </ul> <para> This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-an-archive.html">Deleting an Archive in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html">Delete Archive</a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteArchive service method.</param> <returns>The response from the DeleteArchive service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.DeleteArchiveAsync(Amazon.Glacier.Model.DeleteArchiveRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteArchive operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteArchive operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.DeleteVault(Amazon.Glacier.Model.DeleteVaultRequest)"> <summary> This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use <a>DescribeVault</a> to return the number of archives in a vault, and you can use <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html">Initiate a Job (POST jobs)</a> to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html">Delete Archive (DELETE archive)</a>. <para> This operation is idempotent. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-vaults.html">Deleting a Vault in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-delete.html">Delete Vault </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVault service method.</param> <returns>The response from the DeleteVault service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.DeleteVaultAsync(Amazon.Glacier.Model.DeleteVaultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVault operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVault operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.DeleteVaultAccessPolicy(Amazon.Glacier.Model.DeleteVaultAccessPolicyRequest)"> <summary> This operation deletes the access policy associated with the specified vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely remove the access policy, and you might still see the effect of the policy for a short time after you send the delete request. <para> This operation is idempotent. You can invoke delete multiple times, even if there is no policy associated with the vault. For more information about vault access policies, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html">Amazon Glacier Access Control with Vault Access Policies</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVaultAccessPolicy service method.</param> <returns>The response from the DeleteVaultAccessPolicy service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.DeleteVaultAccessPolicyAsync(Amazon.Glacier.Model.DeleteVaultAccessPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVaultAccessPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVaultAccessPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.DeleteVaultNotifications(Amazon.Glacier.Model.DeleteVaultNotificationsRequest)"> <summary> This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request. <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html">Configuring Vault Notifications in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-delete.html">Delete Vault Notification Configuration </a> in the Amazon Glacier Developer Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVaultNotifications service method.</param> <returns>The response from the DeleteVaultNotifications service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.DeleteVaultNotificationsAsync(Amazon.Glacier.Model.DeleteVaultNotificationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVaultNotifications operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVaultNotifications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.DescribeJob(Amazon.Glacier.Model.DescribeJobRequest)"> <summary> This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon Glacier completes the job. For more information about initiating a job, see <a>InitiateJob</a>. <note> <para> This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Amazon Glacier can notify the topic after it completes the job. </para> </note> <para> A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For information about the underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-describe-job-get.html">Working with Archives in Amazon Glacier</a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeJob service method.</param> <returns>The response from the DescribeJob service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.DescribeJobAsync(Amazon.Glacier.Model.DescribeJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeJob operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.DescribeVault(Amazon.Glacier.Model.DescribeVaultRequest)"> <summary> This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use <a>InitiateJob</a>. Amazon Glacier generates vault inventories approximately daily. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html">Downloading a Vault Inventory in Amazon Glacier</a>. <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html">Retrieving Vault Metadata in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-get.html">Describe Vault </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVault service method.</param> <returns>The response from the DescribeVault service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.DescribeVaultAsync(Amazon.Glacier.Model.DescribeVaultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVault operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVault operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.GetDataRetrievalPolicy(Amazon.Glacier.Model.GetDataRetrievalPolicyRequest)"> <summary> This operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval policies, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html">Amazon Glacier Data Retrieval Policies</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetDataRetrievalPolicy service method.</param> <returns>The response from the GetDataRetrievalPolicy service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.GetDataRetrievalPolicyAsync(Amazon.Glacier.Model.GetDataRetrievalPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDataRetrievalPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDataRetrievalPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.GetJobOutput(Amazon.Glacier.Model.GetJobOutputRequest)"> <summary> This operation downloads the output of the job you initiated using <a>InitiateJob</a>. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory. <para> A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job. </para> <para> If the job output is large, then you can use the <code>Range</code> request header to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output: </para> <ol> <li> <para> Download a 128 MB chunk of output by specifying the appropriate byte range using the <code>Range</code> header. </para> </li> <li> <para> Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data. </para> </li> <li> <para> Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range. </para> </li> <li> <para> After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the <a>DescribeJob</a> API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors. </para> </li> </ol> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and the underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html">Downloading a Vault Inventory</a>, <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/downloading-an-archive.html">Downloading an Archive</a>, and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-job-output-get.html">Get Job Output </a> </para> </summary> <param name="request">Container for the necessary parameters to execute the GetJobOutput service method.</param> <returns>The response from the GetJobOutput service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.GetJobOutputAsync(Amazon.Glacier.Model.GetJobOutputRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetJobOutput operation. </summary> <param name="request">Container for the necessary parameters to execute the GetJobOutput operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.GetVaultAccessPolicy(Amazon.Glacier.Model.GetVaultAccessPolicyRequest)"> <summary> This operation retrieves the <code>access-policy</code> subresource set on the vault; for more information on setting this subresource, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-SetVaultAccessPolicy.html">Set Vault Access Policy (PUT access-policy)</a>. If there is no access policy set on the vault, the operation returns a <code>404 Not found</code> error. For more information about vault access policies, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html">Amazon Glacier Access Control with Vault Access Policies</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetVaultAccessPolicy service method.</param> <returns>The response from the GetVaultAccessPolicy service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.GetVaultAccessPolicyAsync(Amazon.Glacier.Model.GetVaultAccessPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetVaultAccessPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetVaultAccessPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <!-- Badly formed XML comment ignored for member "M:Amazon.Glacier.IAmazonGlacier.GetVaultLock(Amazon.Glacier.Model.GetVaultLockRequest)" --> <member name="M:Amazon.Glacier.IAmazonGlacier.GetVaultLockAsync(Amazon.Glacier.Model.GetVaultLockRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetVaultLock operation. </summary> <param name="request">Container for the necessary parameters to execute the GetVaultLock operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.GetVaultNotifications(Amazon.Glacier.Model.GetVaultNotificationsRequest)"> <summary> This operation retrieves the <code class="code">notification-configuration</code> subresource of the specified vault. <para> For information about setting a notification configuration on a vault, see <a>SetVaultNotifications</a>. If a notification configuration for a vault is not set, the operation returns a <code class="code">404 Not Found</code> error. For more information about vault notifications, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html">Configuring Vault Notifications in Amazon Glacier</a>. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html">Configuring Vault Notifications in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-get.html">Get Vault Notification Configuration </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetVaultNotifications service method.</param> <returns>The response from the GetVaultNotifications service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.GetVaultNotificationsAsync(Amazon.Glacier.Model.GetVaultNotificationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetVaultNotifications operation. </summary> <param name="request">Container for the necessary parameters to execute the GetVaultNotifications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.InitiateJob(Amazon.Glacier.Model.InitiateJobRequest)"> <summary> This operation initiates a job of the specified type. In this release, you can initiate a job to retrieve either an archive or a vault inventory (a list of archives in a vault). <para> Retrieving data from Amazon Glacier is a two-step process: </para> <ol> <li> <para> Initiate a retrieval job. </para> <note> <para> A data retrieval policy can cause your initiate retrieval job request to fail with a PolicyEnforcedException exception. For more information about data retrieval policies, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html">Amazon Glacier Data Retrieval Policies</a>. For more information about the PolicyEnforcedException exception, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-error-responses.html">Error Responses</a>. </para> </note> </li> <li> <para> After the job completes, download the bytes. </para> </li> </ol> <para> The retrieval request is executed asynchronously. When you initiate a retrieval job, Amazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes the job, you can get the job output (archive or inventory data). For information about getting job output, see <a>GetJobOutput</a> operation. </para> <para> The job must complete before you can get its output. To determine when a job is complete, you have the following options: </para> <ul> <li> <para> <b>Use Amazon SNS Notification</b> You can specify an Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Glacier can post a notification after the job is completed. You can specify an SNS topic per job request. The notification is sent only after Amazon Glacier completes the job. In addition to specifying an SNS topic per job request, you can configure vault notifications for a vault so that job notifications are always sent. For more information, see <a>SetVaultNotifications</a>. </para> </li> <li> <para> <b>Get job details</b> You can make a <a>DescribeJob</a> request to obtain job status information while a job is in progress. However, it is more efficient to use an Amazon SNS notification to determine when a job is complete. </para> </li> </ul> <note> <para> The information you get via notification is same that you get by calling <a>DescribeJob</a>. </para> </note> <para> If for a specific event, you add both the notification configuration on the vault and also specify an SNS topic in your initiate job request, Amazon Glacier sends both notifications. For more information, see <a>SetVaultNotifications</a>. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> <b>About the Vault Inventory</b> </para> <para> Amazon Glacier prepares an inventory for each vault periodically, every 24 hours. When you initiate a job for a vault inventory, Amazon Glacier returns the last inventory for the vault. The inventory data you get might be up to a day or two days old. Also, the initiate inventory job might take some time to complete before you can download the vault inventory. So you do not want to retrieve a vault inventory for each vault operation. However, in some scenarios, you might find the vault inventory useful. For example, when you upload an archive, you can provide an archive description but not an archive name. Amazon Glacier provides you a unique archive ID, an opaque string of characters. So, you might maintain your own database that maps archive names to their corresponding Amazon Glacier assigned archive IDs. You might find the vault inventory useful in the event you need to reconcile information in your database with the actual vault inventory. </para> <para> <b>Range Inventory Retrieval</b> </para> <para> You can limit the number of inventory items retrieved by filtering on the archive creation date or by setting a limit. </para> <para> <i>Filtering by Archive Creation Date</i> </para> <para> You can retrieve inventory items for archives created between <code>StartDate</code> and <code>EndDate</code> by specifying values for these parameters in the <b>InitiateJob</b> request. Archives created on or after the <code>StartDate</code> and before the <code>EndDate</code> will be returned. If you only provide the <code>StartDate</code> without the <code>EndDate</code>, you will retrieve the inventory for all archives created on or after the <code>StartDate</code>. If you only provide the <code>EndDate</code> without the <code>StartDate</code>, you will get back the inventory for all archives created before the <code>EndDate</code>. </para> <para> <i>Limiting Inventory Items per Retrieval</i> </para> <para> You can limit the number of inventory items returned by setting the <code>Limit</code> parameter in the <b>InitiateJob</b> request. The inventory job output will contain inventory items up to the specified <code>Limit</code>. If there are more inventory items available, the result is paginated. After a job is complete you can use the <a>DescribeJob</a> operation to get a marker that you use in a subsequent <b>InitiateJob</b> request. The marker will indicate the starting point to retrieve the next set of inventory items. You can page through your entire inventory by repeatedly making <b>InitiateJob</b> requests with the marker from the previous <b>DescribeJob</b> output, until you get a marker from <b>DescribeJob</b> that returns null, indicating that there are no more inventory items available. </para> <para> You can use the <code>Limit</code> parameter together with the date range parameters. </para> <para> <b>About Ranged Archive Retrieval</b> </para> <para> You can initiate an archive retrieval for the whole archive or a range of the archive. In the case of ranged archive retrieval, you specify a byte range to return or the whole archive. The range specified must be megabyte (MB) aligned, that is the range start value must be divisible by 1 MB and range end value plus 1 must be divisible by 1 MB or equal the end of the archive. If the ranged archive retrieval is not megabyte aligned, this operation returns a 400 response. Furthermore, to ensure you get checksum values for data you download using Get Job Output API, the range must be tree hash aligned. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and the underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html">Initiate a Job</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html">Downloading a Vault Inventory</a> </para> </summary> <param name="request">Container for the necessary parameters to execute the InitiateJob service method.</param> <returns>The response from the InitiateJob service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.PolicyEnforcedException"> Returned if a retrieval job would exceed the current data policy's retrieval rate limit. For more information about data retrieval policies, </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.InitiateJobAsync(Amazon.Glacier.Model.InitiateJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the InitiateJob operation. </summary> <param name="request">Container for the necessary parameters to execute the InitiateJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.InitiateMultipartUpload(Amazon.Glacier.Model.InitiateMultipartUploadRequest)"> <summary> This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see <a>UploadMultipartPart</a>). <para> When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB. </para> <para> Every part you upload to this resource (see <a>UploadMultipartPart</a>), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB. </para> <note> <para> You don't need to know the size of the archive when you start a multipart upload because Amazon Glacier does not require you to specify the overall archive size. </para> </note> <para> After you complete the multipart upload, Amazon Glacier removes the multipart upload resource referenced by the ID. Amazon Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html">Uploading Large Archives in Parts (Multipart Upload)</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-initiate-upload.html">Initiate Multipart Upload</a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the InitiateMultipartUpload service method.</param> <returns>The response from the InitiateMultipartUpload service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.InitiateMultipartUploadAsync(Amazon.Glacier.Model.InitiateMultipartUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the InitiateMultipartUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the InitiateMultipartUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <!-- Badly formed XML comment ignored for member "M:Amazon.Glacier.IAmazonGlacier.InitiateVaultLock(Amazon.Glacier.Model.InitiateVaultLockRequest)" --> <member name="M:Amazon.Glacier.IAmazonGlacier.InitiateVaultLockAsync(Amazon.Glacier.Model.InitiateVaultLockRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the InitiateVaultLock operation. </summary> <param name="request">Container for the necessary parameters to execute the InitiateVaultLock operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.ListJobs(Amazon.Glacier.Model.ListJobsRequest)"> <summary> This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. <note> <para> Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists. </para> </note> <para> To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate a job, and after the job completes, you download the data. For an archive retrieval, the output is the archive data, and for an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time. </para> <para> This List Jobs operation supports pagination. By default, this operation returns up to 1,000 jobs in the response. You should always check the response for a <code>marker</code> at which to continue the list; if there are no more items the <code>marker</code> is <code>null</code>. To return a list of jobs that begins at a specific job, set the <code>marker</code> request parameter to the value you obtained from a previous List Jobs request. You can also limit the number of jobs returned in the response by specifying the <code>limit</code> parameter in the request. </para> <para> Additionally, you can filter the jobs list returned by specifying an optional <code>statuscode</code> (InProgress, Succeeded, or Failed) and <code>completed</code> (true, false) parameter. The <code>statuscode</code> allows you to specify that only jobs that match a specified status are returned. The <code>completed</code> parameter allows you to specify that only jobs in a specific completion state are returned. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For the underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-jobs-get.html">List Jobs </a> </para> </summary> <param name="request">Container for the necessary parameters to execute the ListJobs service method.</param> <returns>The response from the ListJobs service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.ListJobsAsync(Amazon.Glacier.Model.ListJobsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListJobs operation. </summary> <param name="request">Container for the necessary parameters to execute the ListJobs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.ListMultipartUploads(Amazon.Glacier.Model.ListMultipartUploadsRequest)"> <summary> This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an <a>InitiateMultipartUpload</a> request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order. <para> The List Multipart Uploads operation supports pagination. By default, this operation returns up to 1,000 multipart uploads in the response. You should always check the response for a <code>marker</code> at which to continue the list; if there are no more items the <code>marker</code> is <code>null</code>. To return a list of multipart uploads that begins at a specific upload, set the <code>marker</code> request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the <code>limit</code> parameter in the request. </para> <para> Note the difference between this operation and listing parts (<a>ListParts</a>). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and the underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html">Working with Archives in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-uploads.html">List Multipart Uploads </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListMultipartUploads service method.</param> <returns>The response from the ListMultipartUploads service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.ListMultipartUploadsAsync(Amazon.Glacier.Model.ListMultipartUploadsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListMultipartUploads operation. </summary> <param name="request">Container for the necessary parameters to execute the ListMultipartUploads operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.ListParts(Amazon.Glacier.Model.ListPartsRequest)"> <summary> This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see <a>CompleteMultipartUpload</a>. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range. <para> The List Parts operation supports pagination. By default, this operation returns up to 1,000 uploaded parts in the response. You should always check the response for a <code class="code">marker</code> at which to continue the list; if there are no more items the <code class="code">marker</code> is <code class="code">null</code>. To return a list of parts that begins at a specific part, set the <code>marker</code> request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the <code>limit</code> parameter in the request. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and the underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html">Working with Archives in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-parts.html">List Parts</a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListParts service method.</param> <returns>The response from the ListParts service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.ListPartsAsync(Amazon.Glacier.Model.ListPartsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListParts operation. </summary> <param name="request">Container for the necessary parameters to execute the ListParts operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.ListTagsForVault(Amazon.Glacier.Model.ListTagsForVaultRequest)"> <summary> This operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html">Tagging Amazon Glacier Resources</a>. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForVault service method.</param> <returns>The response from the ListTagsForVault service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.ListTagsForVaultAsync(Amazon.Glacier.Model.ListTagsForVaultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTagsForVault operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForVault operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.ListVaults"> <summary> This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name. <para> By default, this operation returns up to 1,000 items. If there are more vaults to list, the response <code class="code">marker</code> field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the <code class="code">marker</code> field is <code class="code">null</code>. To return a list of vaults that begins at a specific vault, set the <code class="code">marker</code> request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html">Retrieving Vault Metadata in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vaults-get.html">List Vaults </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <returns>The response from the ListVaults service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.ListVaults(Amazon.Glacier.Model.ListVaultsRequest)"> <summary> This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name. <para> By default, this operation returns up to 1,000 items. If there are more vaults to list, the response <code class="code">marker</code> field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the <code class="code">marker</code> field is <code class="code">null</code>. To return a list of vaults that begins at a specific vault, set the <code class="code">marker</code> request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html">Retrieving Vault Metadata in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vaults-get.html">List Vaults </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListVaults service method.</param> <returns>The response from the ListVaults service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.ListVaultsAsync(Amazon.Glacier.Model.ListVaultsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListVaults operation. </summary> <param name="request">Container for the necessary parameters to execute the ListVaults operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.RemoveTagsFromVault(Amazon.Glacier.Model.RemoveTagsFromVaultRequest)"> <summary> This operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html">Tagging Amazon Glacier Resources</a>. This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromVault service method.</param> <returns>The response from the RemoveTagsFromVault service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.RemoveTagsFromVaultAsync(Amazon.Glacier.Model.RemoveTagsFromVaultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTagsFromVault operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromVault operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.SetDataRetrievalPolicy(Amazon.Glacier.Model.SetDataRetrievalPolicyRequest)"> <summary> This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation. <para> The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html">Amazon Glacier Data Retrieval Policies</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetDataRetrievalPolicy service method.</param> <returns>The response from the SetDataRetrievalPolicy service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.SetDataRetrievalPolicyAsync(Amazon.Glacier.Model.SetDataRetrievalPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetDataRetrievalPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the SetDataRetrievalPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.SetVaultAccessPolicy(Amazon.Glacier.Model.SetVaultAccessPolicyRequest)"> <summary> This operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the <code>access-policy</code> subresource of the vault. An access policy is specific to a vault and is also called a vault subresource. You can set one access policy per vault and the policy can be up to 20 KB in size. For more information about vault access policies, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html">Amazon Glacier Access Control with Vault Access Policies</a>. </summary> <param name="request">Container for the necessary parameters to execute the SetVaultAccessPolicy service method.</param> <returns>The response from the SetVaultAccessPolicy service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.SetVaultAccessPolicyAsync(Amazon.Glacier.Model.SetVaultAccessPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetVaultAccessPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the SetVaultAccessPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.SetVaultNotifications(Amazon.Glacier.Model.SetVaultNotificationsRequest)"> <summary> This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications. <para> To configure vault notifications, send a PUT request to the <code class="code">notification-configuration</code> subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon Glacier to send notifications to the topic. </para> <para> Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events: </para> <ul> <li> <b>ArchiveRetrievalCompleted</b> This event occurs when a job that was initiated for an archive retrieval is completed (<a>InitiateJob</a>). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from <a>DescribeJob</a>. </li> <li> <b>InventoryRetrievalCompleted</b> This event occurs when a job that was initiated for an inventory retrieval is completed (<a>InitiateJob</a>). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from <a>DescribeJob</a>. </li> </ul> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html">Configuring Vault Notifications in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-put.html">Set Vault Notification Configuration </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetVaultNotifications service method.</param> <returns>The response from the SetVaultNotifications service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.SetVaultNotificationsAsync(Amazon.Glacier.Model.SetVaultNotificationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetVaultNotifications operation. </summary> <param name="request">Container for the necessary parameters to execute the SetVaultNotifications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.UploadArchive(Amazon.Glacier.Model.UploadArchiveRequest)"> <summary> This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon Glacier returns the archive ID in the <code class="code">x-amz-archive-id</code> header of the response. <para> You must use the archive ID to access your data in Amazon Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see <a>InitiateJob</a>. </para> <para> You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html">Computing Checksums</a>. </para> <para> You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see <a>InitiateJob</a>. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list. </para> <para> Archives are immutable. After you upload an archive, you cannot edit the archive or its description. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-an-archive.html">Uploading an Archive in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html">Upload Archive</a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UploadArchive service method.</param> <returns>The response from the UploadArchive service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.RequestTimeoutException"> Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.UploadArchiveAsync(Amazon.Glacier.Model.UploadArchiveRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UploadArchive operation. </summary> <param name="request">Container for the necessary parameters to execute the UploadArchive operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.UploadMultipartPart(Amazon.Glacier.Model.UploadMultipartPartRequest)"> <summary> This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload. <para> Amazon Glacier rejects your upload part request if any of the following conditions is true: </para> <ul> <li> <para> <b>SHA256 tree hash does not match</b>To ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html">Computing Checksums</a>. </para> </li> <li> <para> <b>Part size does not match</b>The size of each part except the last must match the size specified in the corresponding <a>InitiateMultipartUpload</a> request. The size of the last part must be the same size as, or smaller than, the specified size. </para> <note> <para> If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail. </para> </note> </li> <li> <b>Range does not align</b>The byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail. </li> </ul> <para> This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html">Uploading Large Archives in Parts (Multipart Upload)</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-upload-part.html">Upload Part </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UploadMultipartPart service method.</param> <returns>The response from the UploadMultipartPart service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.RequestTimeoutException"> Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.IAmazonGlacier.UploadMultipartPartAsync(Amazon.Glacier.Model.UploadMultipartPartRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UploadMultipartPart operation. </summary> <param name="request">Container for the necessary parameters to execute the UploadMultipartPart operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.#ctor"> <summary> Constructs AmazonGlacierClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonGlacierClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.#ctor(Amazon.Glacier.AmazonGlacierConfig)"> <summary> Constructs AmazonGlacierClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonGlacierClient Configuration Object</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonGlacierClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonGlacierClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.Glacier.AmazonGlacierConfig)"> <summary> Constructs AmazonGlacierClient with AWS Credentials and an AmazonGlacierClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonGlacierClient Configuration Object</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonGlacierClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonGlacierClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.#ctor(System.String,System.String,Amazon.Glacier.AmazonGlacierConfig)"> <summary> Constructs AmazonGlacierClient with AWS Access Key ID, AWS Secret Key and an AmazonGlacierClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonGlacierClient Configuration Object</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonGlacierClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonGlacierClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.#ctor(System.String,System.String,System.String,Amazon.Glacier.AmazonGlacierConfig)"> <summary> Constructs AmazonGlacierClient with AWS Access Key ID, AWS Secret Key and an AmazonGlacierClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonGlacierClient Configuration Object</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.AbortMultipartUpload(Amazon.Glacier.Model.AbortMultipartUploadRequest)"> <summary> This operation aborts a multipart upload identified by the upload ID. <para> After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see <a>UploadMultipartPart</a> and <a>CompleteMultipartUpload</a>. </para> <para> This operation is idempotent. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html">Working with Archives in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html">Abort Multipart Upload</a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AbortMultipartUpload service method.</param> <returns>The response from the AbortMultipartUpload service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.AbortMultipartUploadAsync(Amazon.Glacier.Model.AbortMultipartUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AbortMultipartUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the AbortMultipartUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.AbortVaultLock(Amazon.Glacier.Model.AbortVaultLockRequest)"> <summary> This operation aborts the vault locking process if the vault lock is not in the <code>Locked</code> state. If the vault lock is in the <code>Locked</code> state when this operation is requested, the operation returns an <code>AccessDeniedException</code> error. Aborting the vault locking process removes the vault lock policy from the specified vault. <para> A vault lock is put into the <code>InProgress</code> state by calling <a>InitiateVaultLock</a>. A vault lock is put into the <code>Locked</code> state by calling <a>CompleteVaultLock</a>. You can get the state of a vault lock by calling <a>GetVaultLock</a>. For more information about the vault locking process, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html">Amazon Glacier Vault Lock</a>. For more information about vault lock policies, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html">Amazon Glacier Access Control with Vault Lock Policies</a>. </para> <para> This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the <code>InProgress</code> state or if there is no policy associated with the vault. </para> </summary> <param name="request">Container for the necessary parameters to execute the AbortVaultLock service method.</param> <returns>The response from the AbortVaultLock service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.AbortVaultLockAsync(Amazon.Glacier.Model.AbortVaultLockRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AbortVaultLock operation. </summary> <param name="request">Container for the necessary parameters to execute the AbortVaultLock operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.AddTagsToVault(Amazon.Glacier.Model.AddTagsToVaultRequest)"> <summary> This operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the tag limit for the vault to be exceeded, the operation throws the <code>LimitExceededException</code> error. If a tag already exists on the vault under a specified key, the existing key value will be overwritten. For more information about tags, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html">Tagging Amazon Glacier Resources</a>. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToVault service method.</param> <returns>The response from the AddTagsToVault service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.LimitExceededException"> Returned if the request results in a vault or account limit being exceeded. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.AddTagsToVaultAsync(Amazon.Glacier.Model.AddTagsToVaultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTagsToVault operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToVault operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.CompleteMultipartUpload(Amazon.Glacier.Model.CompleteMultipartUploadRequest)"> <summary> You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see <a>InitiateJob</a>. <para> In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html">Computing Checksums</a>. On the server side, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The <a>ListParts</a> operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue. </para> <para> Additionally, Amazon Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Amazon Glacier returns an error and the operation fails. </para> <para> Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html">Uploading Large Archives in Parts (Multipart Upload)</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-complete-upload.html">Complete Multipart Upload</a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CompleteMultipartUpload service method.</param> <returns>The response from the CompleteMultipartUpload service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.CompleteMultipartUploadAsync(Amazon.Glacier.Model.CompleteMultipartUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CompleteMultipartUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the CompleteMultipartUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.CompleteVaultLock(Amazon.Glacier.Model.CompleteVaultLockRequest)"> <summary> This operation completes the vault locking process by transitioning the vault lock from the <code>InProgress</code> state to the <code>Locked</code> state, which causes the vault lock policy to become unchangeable. A vault lock is put into the <code>InProgress</code> state by calling <a>InitiateVaultLock</a>. You can obtain the state of the vault lock by calling <a>GetVaultLock</a>. For more information about the vault locking process, <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html">Amazon Glacier Vault Lock</a>. <para> This operation is idempotent. This request is always successful if the vault lock is in the <code>Locked</code> state and the provided lock ID matches the lock ID originally used to lock the vault. </para> <para> If an invalid lock ID is passed in the request when the vault lock is in the <code>Locked</code> state, the operation returns an <code>AccessDeniedException</code> error. If an invalid lock ID is passed in the request when the vault lock is in the <code>InProgress</code> state, the operation throws an <code>InvalidParameter</code> error. </para> </summary> <param name="request">Container for the necessary parameters to execute the CompleteVaultLock service method.</param> <returns>The response from the CompleteVaultLock service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.CompleteVaultLockAsync(Amazon.Glacier.Model.CompleteVaultLockRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CompleteVaultLock operation. </summary> <param name="request">Container for the necessary parameters to execute the CompleteVaultLock operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.CreateVault(Amazon.Glacier.Model.CreateVaultRequest)"> <summary> This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon Glacier. <para> You must use the following guidelines when naming a vault. </para> <para> <ul> <li> <para> Names can be between 1 and 255 characters long. </para> </li> <li> <para> Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period). </para> </li> </ul> </para> <para> This operation is idempotent. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/creating-vaults.html">Creating a Vault in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-put.html">Create Vault </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVault service method.</param> <returns>The response from the CreateVault service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.LimitExceededException"> Returned if the request results in a vault or account limit being exceeded. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.CreateVaultAsync(Amazon.Glacier.Model.CreateVaultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVault operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVault operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DeleteArchive(Amazon.Glacier.Model.DeleteArchiveRequest)"> <summary> This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios: <ul> <li>If the archive retrieval job is actively preparing the data for download when Amazon Glacier receives the delete archive request, the archival retrieval operation might fail. </li> <li>If the archive retrieval job has successfully prepared the archive for download when Amazon Glacier receives the delete archive request, you will be able to download the output. </li> </ul> <para> This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-an-archive.html">Deleting an Archive in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html">Delete Archive</a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteArchive service method.</param> <returns>The response from the DeleteArchive service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DeleteArchiveAsync(Amazon.Glacier.Model.DeleteArchiveRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteArchive operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteArchive operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DeleteVault(Amazon.Glacier.Model.DeleteVaultRequest)"> <summary> This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use <a>DescribeVault</a> to return the number of archives in a vault, and you can use <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html">Initiate a Job (POST jobs)</a> to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html">Delete Archive (DELETE archive)</a>. <para> This operation is idempotent. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-vaults.html">Deleting a Vault in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-delete.html">Delete Vault </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVault service method.</param> <returns>The response from the DeleteVault service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DeleteVaultAsync(Amazon.Glacier.Model.DeleteVaultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVault operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVault operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DeleteVaultAccessPolicy(Amazon.Glacier.Model.DeleteVaultAccessPolicyRequest)"> <summary> This operation deletes the access policy associated with the specified vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely remove the access policy, and you might still see the effect of the policy for a short time after you send the delete request. <para> This operation is idempotent. You can invoke delete multiple times, even if there is no policy associated with the vault. For more information about vault access policies, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html">Amazon Glacier Access Control with Vault Access Policies</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVaultAccessPolicy service method.</param> <returns>The response from the DeleteVaultAccessPolicy service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DeleteVaultAccessPolicyAsync(Amazon.Glacier.Model.DeleteVaultAccessPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVaultAccessPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVaultAccessPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DeleteVaultNotifications(Amazon.Glacier.Model.DeleteVaultNotificationsRequest)"> <summary> This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request. <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html">Configuring Vault Notifications in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-delete.html">Delete Vault Notification Configuration </a> in the Amazon Glacier Developer Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVaultNotifications service method.</param> <returns>The response from the DeleteVaultNotifications service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DeleteVaultNotificationsAsync(Amazon.Glacier.Model.DeleteVaultNotificationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVaultNotifications operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVaultNotifications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DescribeJob(Amazon.Glacier.Model.DescribeJobRequest)"> <summary> This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon Glacier completes the job. For more information about initiating a job, see <a>InitiateJob</a>. <note> <para> This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Amazon Glacier can notify the topic after it completes the job. </para> </note> <para> A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For information about the underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-describe-job-get.html">Working with Archives in Amazon Glacier</a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeJob service method.</param> <returns>The response from the DescribeJob service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DescribeJobAsync(Amazon.Glacier.Model.DescribeJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeJob operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DescribeVault(Amazon.Glacier.Model.DescribeVaultRequest)"> <summary> This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use <a>InitiateJob</a>. Amazon Glacier generates vault inventories approximately daily. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html">Downloading a Vault Inventory in Amazon Glacier</a>. <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html">Retrieving Vault Metadata in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-get.html">Describe Vault </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVault service method.</param> <returns>The response from the DescribeVault service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DescribeVaultAsync(Amazon.Glacier.Model.DescribeVaultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVault operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVault operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.GetDataRetrievalPolicy(Amazon.Glacier.Model.GetDataRetrievalPolicyRequest)"> <summary> This operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval policies, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html">Amazon Glacier Data Retrieval Policies</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetDataRetrievalPolicy service method.</param> <returns>The response from the GetDataRetrievalPolicy service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.GetDataRetrievalPolicyAsync(Amazon.Glacier.Model.GetDataRetrievalPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDataRetrievalPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDataRetrievalPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.GetJobOutput(Amazon.Glacier.Model.GetJobOutputRequest)"> <summary> This operation downloads the output of the job you initiated using <a>InitiateJob</a>. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory. <para> A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job. </para> <para> If the job output is large, then you can use the <code>Range</code> request header to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output: </para> <ol> <li> <para> Download a 128 MB chunk of output by specifying the appropriate byte range using the <code>Range</code> header. </para> </li> <li> <para> Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data. </para> </li> <li> <para> Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range. </para> </li> <li> <para> After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the <a>DescribeJob</a> API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors. </para> </li> </ol> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and the underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html">Downloading a Vault Inventory</a>, <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/downloading-an-archive.html">Downloading an Archive</a>, and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-job-output-get.html">Get Job Output </a> </para> </summary> <param name="request">Container for the necessary parameters to execute the GetJobOutput service method.</param> <returns>The response from the GetJobOutput service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.GetJobOutputAsync(Amazon.Glacier.Model.GetJobOutputRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetJobOutput operation. </summary> <param name="request">Container for the necessary parameters to execute the GetJobOutput operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.GetVaultAccessPolicy(Amazon.Glacier.Model.GetVaultAccessPolicyRequest)"> <summary> This operation retrieves the <code>access-policy</code> subresource set on the vault; for more information on setting this subresource, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-SetVaultAccessPolicy.html">Set Vault Access Policy (PUT access-policy)</a>. If there is no access policy set on the vault, the operation returns a <code>404 Not found</code> error. For more information about vault access policies, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html">Amazon Glacier Access Control with Vault Access Policies</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetVaultAccessPolicy service method.</param> <returns>The response from the GetVaultAccessPolicy service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.GetVaultAccessPolicyAsync(Amazon.Glacier.Model.GetVaultAccessPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetVaultAccessPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetVaultAccessPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <!-- Badly formed XML comment ignored for member "M:Amazon.Glacier.AmazonGlacierClient.GetVaultLock(Amazon.Glacier.Model.GetVaultLockRequest)" --> <member name="M:Amazon.Glacier.AmazonGlacierClient.GetVaultLockAsync(Amazon.Glacier.Model.GetVaultLockRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetVaultLock operation. </summary> <param name="request">Container for the necessary parameters to execute the GetVaultLock operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.GetVaultNotifications(Amazon.Glacier.Model.GetVaultNotificationsRequest)"> <summary> This operation retrieves the <code class="code">notification-configuration</code> subresource of the specified vault. <para> For information about setting a notification configuration on a vault, see <a>SetVaultNotifications</a>. If a notification configuration for a vault is not set, the operation returns a <code class="code">404 Not Found</code> error. For more information about vault notifications, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html">Configuring Vault Notifications in Amazon Glacier</a>. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html">Configuring Vault Notifications in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-get.html">Get Vault Notification Configuration </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetVaultNotifications service method.</param> <returns>The response from the GetVaultNotifications service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.GetVaultNotificationsAsync(Amazon.Glacier.Model.GetVaultNotificationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetVaultNotifications operation. </summary> <param name="request">Container for the necessary parameters to execute the GetVaultNotifications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.InitiateJob(Amazon.Glacier.Model.InitiateJobRequest)"> <summary> This operation initiates a job of the specified type. In this release, you can initiate a job to retrieve either an archive or a vault inventory (a list of archives in a vault). <para> Retrieving data from Amazon Glacier is a two-step process: </para> <ol> <li> <para> Initiate a retrieval job. </para> <note> <para> A data retrieval policy can cause your initiate retrieval job request to fail with a PolicyEnforcedException exception. For more information about data retrieval policies, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html">Amazon Glacier Data Retrieval Policies</a>. For more information about the PolicyEnforcedException exception, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-error-responses.html">Error Responses</a>. </para> </note> </li> <li> <para> After the job completes, download the bytes. </para> </li> </ol> <para> The retrieval request is executed asynchronously. When you initiate a retrieval job, Amazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes the job, you can get the job output (archive or inventory data). For information about getting job output, see <a>GetJobOutput</a> operation. </para> <para> The job must complete before you can get its output. To determine when a job is complete, you have the following options: </para> <ul> <li> <para> <b>Use Amazon SNS Notification</b> You can specify an Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Glacier can post a notification after the job is completed. You can specify an SNS topic per job request. The notification is sent only after Amazon Glacier completes the job. In addition to specifying an SNS topic per job request, you can configure vault notifications for a vault so that job notifications are always sent. For more information, see <a>SetVaultNotifications</a>. </para> </li> <li> <para> <b>Get job details</b> You can make a <a>DescribeJob</a> request to obtain job status information while a job is in progress. However, it is more efficient to use an Amazon SNS notification to determine when a job is complete. </para> </li> </ul> <note> <para> The information you get via notification is same that you get by calling <a>DescribeJob</a>. </para> </note> <para> If for a specific event, you add both the notification configuration on the vault and also specify an SNS topic in your initiate job request, Amazon Glacier sends both notifications. For more information, see <a>SetVaultNotifications</a>. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> <b>About the Vault Inventory</b> </para> <para> Amazon Glacier prepares an inventory for each vault periodically, every 24 hours. When you initiate a job for a vault inventory, Amazon Glacier returns the last inventory for the vault. The inventory data you get might be up to a day or two days old. Also, the initiate inventory job might take some time to complete before you can download the vault inventory. So you do not want to retrieve a vault inventory for each vault operation. However, in some scenarios, you might find the vault inventory useful. For example, when you upload an archive, you can provide an archive description but not an archive name. Amazon Glacier provides you a unique archive ID, an opaque string of characters. So, you might maintain your own database that maps archive names to their corresponding Amazon Glacier assigned archive IDs. You might find the vault inventory useful in the event you need to reconcile information in your database with the actual vault inventory. </para> <para> <b>Range Inventory Retrieval</b> </para> <para> You can limit the number of inventory items retrieved by filtering on the archive creation date or by setting a limit. </para> <para> <i>Filtering by Archive Creation Date</i> </para> <para> You can retrieve inventory items for archives created between <code>StartDate</code> and <code>EndDate</code> by specifying values for these parameters in the <b>InitiateJob</b> request. Archives created on or after the <code>StartDate</code> and before the <code>EndDate</code> will be returned. If you only provide the <code>StartDate</code> without the <code>EndDate</code>, you will retrieve the inventory for all archives created on or after the <code>StartDate</code>. If you only provide the <code>EndDate</code> without the <code>StartDate</code>, you will get back the inventory for all archives created before the <code>EndDate</code>. </para> <para> <i>Limiting Inventory Items per Retrieval</i> </para> <para> You can limit the number of inventory items returned by setting the <code>Limit</code> parameter in the <b>InitiateJob</b> request. The inventory job output will contain inventory items up to the specified <code>Limit</code>. If there are more inventory items available, the result is paginated. After a job is complete you can use the <a>DescribeJob</a> operation to get a marker that you use in a subsequent <b>InitiateJob</b> request. The marker will indicate the starting point to retrieve the next set of inventory items. You can page through your entire inventory by repeatedly making <b>InitiateJob</b> requests with the marker from the previous <b>DescribeJob</b> output, until you get a marker from <b>DescribeJob</b> that returns null, indicating that there are no more inventory items available. </para> <para> You can use the <code>Limit</code> parameter together with the date range parameters. </para> <para> <b>About Ranged Archive Retrieval</b> </para> <para> You can initiate an archive retrieval for the whole archive or a range of the archive. In the case of ranged archive retrieval, you specify a byte range to return or the whole archive. The range specified must be megabyte (MB) aligned, that is the range start value must be divisible by 1 MB and range end value plus 1 must be divisible by 1 MB or equal the end of the archive. If the ranged archive retrieval is not megabyte aligned, this operation returns a 400 response. Furthermore, to ensure you get checksum values for data you download using Get Job Output API, the range must be tree hash aligned. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and the underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html">Initiate a Job</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html">Downloading a Vault Inventory</a> </para> </summary> <param name="request">Container for the necessary parameters to execute the InitiateJob service method.</param> <returns>The response from the InitiateJob service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.PolicyEnforcedException"> Returned if a retrieval job would exceed the current data policy's retrieval rate limit. For more information about data retrieval policies, </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.InitiateJobAsync(Amazon.Glacier.Model.InitiateJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the InitiateJob operation. </summary> <param name="request">Container for the necessary parameters to execute the InitiateJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.InitiateMultipartUpload(Amazon.Glacier.Model.InitiateMultipartUploadRequest)"> <summary> This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see <a>UploadMultipartPart</a>). <para> When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB. </para> <para> Every part you upload to this resource (see <a>UploadMultipartPart</a>), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB. </para> <note> <para> You don't need to know the size of the archive when you start a multipart upload because Amazon Glacier does not require you to specify the overall archive size. </para> </note> <para> After you complete the multipart upload, Amazon Glacier removes the multipart upload resource referenced by the ID. Amazon Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html">Uploading Large Archives in Parts (Multipart Upload)</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-initiate-upload.html">Initiate Multipart Upload</a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the InitiateMultipartUpload service method.</param> <returns>The response from the InitiateMultipartUpload service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.InitiateMultipartUploadAsync(Amazon.Glacier.Model.InitiateMultipartUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the InitiateMultipartUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the InitiateMultipartUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <!-- Badly formed XML comment ignored for member "M:Amazon.Glacier.AmazonGlacierClient.InitiateVaultLock(Amazon.Glacier.Model.InitiateVaultLockRequest)" --> <member name="M:Amazon.Glacier.AmazonGlacierClient.InitiateVaultLockAsync(Amazon.Glacier.Model.InitiateVaultLockRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the InitiateVaultLock operation. </summary> <param name="request">Container for the necessary parameters to execute the InitiateVaultLock operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.ListJobs(Amazon.Glacier.Model.ListJobsRequest)"> <summary> This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. <note> <para> Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists. </para> </note> <para> To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate a job, and after the job completes, you download the data. For an archive retrieval, the output is the archive data, and for an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time. </para> <para> This List Jobs operation supports pagination. By default, this operation returns up to 1,000 jobs in the response. You should always check the response for a <code>marker</code> at which to continue the list; if there are no more items the <code>marker</code> is <code>null</code>. To return a list of jobs that begins at a specific job, set the <code>marker</code> request parameter to the value you obtained from a previous List Jobs request. You can also limit the number of jobs returned in the response by specifying the <code>limit</code> parameter in the request. </para> <para> Additionally, you can filter the jobs list returned by specifying an optional <code>statuscode</code> (InProgress, Succeeded, or Failed) and <code>completed</code> (true, false) parameter. The <code>statuscode</code> allows you to specify that only jobs that match a specified status are returned. The <code>completed</code> parameter allows you to specify that only jobs in a specific completion state are returned. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For the underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-jobs-get.html">List Jobs </a> </para> </summary> <param name="request">Container for the necessary parameters to execute the ListJobs service method.</param> <returns>The response from the ListJobs service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.ListJobsAsync(Amazon.Glacier.Model.ListJobsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListJobs operation. </summary> <param name="request">Container for the necessary parameters to execute the ListJobs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.ListMultipartUploads(Amazon.Glacier.Model.ListMultipartUploadsRequest)"> <summary> This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an <a>InitiateMultipartUpload</a> request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order. <para> The List Multipart Uploads operation supports pagination. By default, this operation returns up to 1,000 multipart uploads in the response. You should always check the response for a <code>marker</code> at which to continue the list; if there are no more items the <code>marker</code> is <code>null</code>. To return a list of multipart uploads that begins at a specific upload, set the <code>marker</code> request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the <code>limit</code> parameter in the request. </para> <para> Note the difference between this operation and listing parts (<a>ListParts</a>). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and the underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html">Working with Archives in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-uploads.html">List Multipart Uploads </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListMultipartUploads service method.</param> <returns>The response from the ListMultipartUploads service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.ListMultipartUploadsAsync(Amazon.Glacier.Model.ListMultipartUploadsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListMultipartUploads operation. </summary> <param name="request">Container for the necessary parameters to execute the ListMultipartUploads operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.ListParts(Amazon.Glacier.Model.ListPartsRequest)"> <summary> This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see <a>CompleteMultipartUpload</a>. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range. <para> The List Parts operation supports pagination. By default, this operation returns up to 1,000 uploaded parts in the response. You should always check the response for a <code class="code">marker</code> at which to continue the list; if there are no more items the <code class="code">marker</code> is <code class="code">null</code>. To return a list of parts that begins at a specific part, set the <code>marker</code> request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the <code>limit</code> parameter in the request. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and the underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html">Working with Archives in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-parts.html">List Parts</a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListParts service method.</param> <returns>The response from the ListParts service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.ListPartsAsync(Amazon.Glacier.Model.ListPartsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListParts operation. </summary> <param name="request">Container for the necessary parameters to execute the ListParts operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.ListTagsForVault(Amazon.Glacier.Model.ListTagsForVaultRequest)"> <summary> This operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html">Tagging Amazon Glacier Resources</a>. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForVault service method.</param> <returns>The response from the ListTagsForVault service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.ListTagsForVaultAsync(Amazon.Glacier.Model.ListTagsForVaultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTagsForVault operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForVault operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.ListVaults"> <summary> This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name. <para> By default, this operation returns up to 1,000 items. If there are more vaults to list, the response <code class="code">marker</code> field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the <code class="code">marker</code> field is <code class="code">null</code>. To return a list of vaults that begins at a specific vault, set the <code class="code">marker</code> request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html">Retrieving Vault Metadata in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vaults-get.html">List Vaults </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <returns>The response from the ListVaults service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.ListVaults(Amazon.Glacier.Model.ListVaultsRequest)"> <summary> This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name. <para> By default, this operation returns up to 1,000 items. If there are more vaults to list, the response <code class="code">marker</code> field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the <code class="code">marker</code> field is <code class="code">null</code>. To return a list of vaults that begins at a specific vault, set the <code class="code">marker</code> request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html">Retrieving Vault Metadata in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vaults-get.html">List Vaults </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListVaults service method.</param> <returns>The response from the ListVaults service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.ListVaultsAsync(Amazon.Glacier.Model.ListVaultsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListVaults operation. </summary> <param name="request">Container for the necessary parameters to execute the ListVaults operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.RemoveTagsFromVault(Amazon.Glacier.Model.RemoveTagsFromVaultRequest)"> <summary> This operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html">Tagging Amazon Glacier Resources</a>. This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromVault service method.</param> <returns>The response from the RemoveTagsFromVault service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.RemoveTagsFromVaultAsync(Amazon.Glacier.Model.RemoveTagsFromVaultRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTagsFromVault operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromVault operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.SetDataRetrievalPolicy(Amazon.Glacier.Model.SetDataRetrievalPolicyRequest)"> <summary> This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation. <para> The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html">Amazon Glacier Data Retrieval Policies</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetDataRetrievalPolicy service method.</param> <returns>The response from the SetDataRetrievalPolicy service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.SetDataRetrievalPolicyAsync(Amazon.Glacier.Model.SetDataRetrievalPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetDataRetrievalPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the SetDataRetrievalPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.SetVaultAccessPolicy(Amazon.Glacier.Model.SetVaultAccessPolicyRequest)"> <summary> This operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the <code>access-policy</code> subresource of the vault. An access policy is specific to a vault and is also called a vault subresource. You can set one access policy per vault and the policy can be up to 20 KB in size. For more information about vault access policies, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html">Amazon Glacier Access Control with Vault Access Policies</a>. </summary> <param name="request">Container for the necessary parameters to execute the SetVaultAccessPolicy service method.</param> <returns>The response from the SetVaultAccessPolicy service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.SetVaultAccessPolicyAsync(Amazon.Glacier.Model.SetVaultAccessPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetVaultAccessPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the SetVaultAccessPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.SetVaultNotifications(Amazon.Glacier.Model.SetVaultNotificationsRequest)"> <summary> This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications. <para> To configure vault notifications, send a PUT request to the <code class="code">notification-configuration</code> subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon Glacier to send notifications to the topic. </para> <para> Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events: </para> <ul> <li> <b>ArchiveRetrievalCompleted</b> This event occurs when a job that was initiated for an archive retrieval is completed (<a>InitiateJob</a>). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from <a>DescribeJob</a>. </li> <li> <b>InventoryRetrievalCompleted</b> This event occurs when a job that was initiated for an inventory retrieval is completed (<a>InitiateJob</a>). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from <a>DescribeJob</a>. </li> </ul> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html">Configuring Vault Notifications in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-put.html">Set Vault Notification Configuration </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetVaultNotifications service method.</param> <returns>The response from the SetVaultNotifications service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.SetVaultNotificationsAsync(Amazon.Glacier.Model.SetVaultNotificationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetVaultNotifications operation. </summary> <param name="request">Container for the necessary parameters to execute the SetVaultNotifications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.UploadArchive(Amazon.Glacier.Model.UploadArchiveRequest)"> <summary> This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon Glacier returns the archive ID in the <code class="code">x-amz-archive-id</code> header of the response. <para> You must use the archive ID to access your data in Amazon Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see <a>InitiateJob</a>. </para> <para> You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html">Computing Checksums</a>. </para> <para> You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see <a>InitiateJob</a>. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list. </para> <para> Archives are immutable. After you upload an archive, you cannot edit the archive or its description. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-an-archive.html">Uploading an Archive in Amazon Glacier</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html">Upload Archive</a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UploadArchive service method.</param> <returns>The response from the UploadArchive service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.RequestTimeoutException"> Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.UploadArchiveAsync(Amazon.Glacier.Model.UploadArchiveRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UploadArchive operation. </summary> <param name="request">Container for the necessary parameters to execute the UploadArchive operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.UploadMultipartPart(Amazon.Glacier.Model.UploadMultipartPartRequest)"> <summary> This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload. <para> Amazon Glacier rejects your upload part request if any of the following conditions is true: </para> <ul> <li> <para> <b>SHA256 tree hash does not match</b>To ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html">Computing Checksums</a>. </para> </li> <li> <para> <b>Part size does not match</b>The size of each part except the last must match the size specified in the corresponding <a>InitiateMultipartUpload</a> request. The size of the last part must be the same size as, or smaller than, the specified size. </para> <note> <para> If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail. </para> </note> </li> <li> <b>Range does not align</b>The byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail. </li> </ul> <para> This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data. </para> <para> An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using AWS Identity and Access Management (IAM)</a>. </para> <para> For conceptual information and underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html">Uploading Large Archives in Parts (Multipart Upload)</a> and <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-upload-part.html">Upload Part </a> in the <i>Amazon Glacier Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UploadMultipartPart service method.</param> <returns>The response from the UploadMultipartPart service method, as returned by Glacier.</returns> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"> Returned if a required header or parameter is missing from the request. </exception> <exception cref="T:Amazon.Glacier.Model.RequestTimeoutException"> Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload. </exception> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"> Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. </exception> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.UploadMultipartPartAsync(Amazon.Glacier.Model.UploadMultipartPartRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UploadMultipartPart operation. </summary> <param name="request">Container for the necessary parameters to execute the UploadMultipartPart operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient"> <summary> Implementation for accessing IdentityManagementService AWS Identity and Access Management <para> AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions under your AWS account. This guide provides descriptions of IAM actions that you can call programmatically. For general information about IAM, see <a href="http://aws.amazon.com/iam/">AWS Identity and Access Management (IAM)</a>. For the user guide for IAM, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/">Using IAM</a>. </para> <note>AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to IAM and AWS. For example, the SDKs take care of tasks such as cryptographically signing requests (see below), managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a> page. </note> <para> We recommend that you use the AWS SDKs to make programmatic API calls to IAM. However, you can also use the IAM Query API to make direct calls to the IAM web service. To learn more about the IAM Query API, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in the <i>Using IAM</i> guide. IAM supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request. </para> <para> <b>Signing Requests</b> </para> <para> Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret access key for everyday work with IAM. You can use the access key ID and secret access key for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials and use those to sign requests. </para> <para> To sign requests, we recommend that you use <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement. </para> <para> <b>Additional Resources</b> </para> <para> For more information, see the following: </para> <ul> <li> <a href="http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">AWS Security Credentials</a>. This topic provides general information about the types of credentials used for accessing AWS. </li> <li> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAMBestPractices.html">IAM Best Practices</a>. This topic presents a list of suggestions for using the IAM service to help secure your AWS resources. </li> <li> <a href="http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing AWS API Requests</a>. This set of topics walk you through the process of signing a request using an access key ID and secret access key. </li> </ul> </summary> </member> <member name="T:Amazon.IdentityManagement.IAmazonIdentityManagementService"> <summary> Interface for accessing IdentityManagementService AWS Identity and Access Management <para> AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions under your AWS account. This guide provides descriptions of IAM actions that you can call programmatically. For general information about IAM, see <a href="http://aws.amazon.com/iam/">AWS Identity and Access Management (IAM)</a>. For the user guide for IAM, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/">Using IAM</a>. </para> <note>AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to IAM and AWS. For example, the SDKs take care of tasks such as cryptographically signing requests (see below), managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a> page. </note> <para> We recommend that you use the AWS SDKs to make programmatic API calls to IAM. However, you can also use the IAM Query API to make direct calls to the IAM web service. To learn more about the IAM Query API, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in the <i>Using IAM</i> guide. IAM supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request. </para> <para> <b>Signing Requests</b> </para> <para> Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret access key for everyday work with IAM. You can use the access key ID and secret access key for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials and use those to sign requests. </para> <para> To sign requests, we recommend that you use <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement. </para> <para> <b>Additional Resources</b> </para> <para> For more information, see the following: </para> <ul> <li> <a href="http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">AWS Security Credentials</a>. This topic provides general information about the types of credentials used for accessing AWS. </li> <li> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAMBestPractices.html">IAM Best Practices</a>. This topic presents a list of suggestions for using the IAM service to help secure your AWS resources. </li> <li> <a href="http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing AWS API Requests</a>. This set of topics walk you through the process of signing a request using an access key ID and secret access key. </li> </ul> </summary> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.AddClientIDToOpenIDConnectProvider(Amazon.IdentityManagement.Model.AddClientIDToOpenIDConnectProviderRequest)"> <summary> Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect provider. <para> This action is idempotent; it does not fail or return an error if you add an existing client ID to the provider. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddClientIDToOpenIDConnectProvider service method.</param> <returns>The response from the AddClientIDToOpenIDConnectProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.AddClientIDToOpenIDConnectProviderAsync(Amazon.IdentityManagement.Model.AddClientIDToOpenIDConnectProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddClientIDToOpenIDConnectProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the AddClientIDToOpenIDConnectProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.AddRoleToInstanceProfile(Amazon.IdentityManagement.Model.AddRoleToInstanceProfileRequest)"> <summary> Adds the specified role to the specified instance profile. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. </summary> <param name="request">Container for the necessary parameters to execute the AddRoleToInstanceProfile service method.</param> <returns>The response from the AddRoleToInstanceProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.AddRoleToInstanceProfileAsync(Amazon.IdentityManagement.Model.AddRoleToInstanceProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddRoleToInstanceProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the AddRoleToInstanceProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.AddUserToGroup(Amazon.IdentityManagement.Model.AddUserToGroupRequest)"> <summary> Adds the specified user to the specified group. </summary> <param name="request">Container for the necessary parameters to execute the AddUserToGroup service method.</param> <returns>The response from the AddUserToGroup service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.AddUserToGroupAsync(Amazon.IdentityManagement.Model.AddUserToGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddUserToGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the AddUserToGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.AttachGroupPolicy(Amazon.IdentityManagement.Model.AttachGroupPolicyRequest)"> <summary> Attaches the specified managed policy to the specified group. <para> You use this API to attach a managed policy to a group. To embed an inline policy in a group, use <a>PutGroupPolicy</a>. </para> <para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachGroupPolicy service method.</param> <returns>The response from the AttachGroupPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.AttachGroupPolicyAsync(Amazon.IdentityManagement.Model.AttachGroupPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachGroupPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachGroupPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.AttachRolePolicy(Amazon.IdentityManagement.Model.AttachRolePolicyRequest)"> <summary> Attaches the specified managed policy to the specified role. <para> When you attach a managed policy to a role, the managed policy is used as the role's access (permissions) policy. You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using <a>CreateRole</a>. You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>. </para> <para> Use this API to attach a managed policy to a role. To embed an inline policy in a role, use <a>PutRolePolicy</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachRolePolicy service method.</param> <returns>The response from the AttachRolePolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.AttachRolePolicyAsync(Amazon.IdentityManagement.Model.AttachRolePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachRolePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachRolePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.AttachUserPolicy(Amazon.IdentityManagement.Model.AttachUserPolicyRequest)"> <summary> Attaches the specified managed policy to the specified user. <para> You use this API to attach a managed policy to a user. To embed an inline policy in a user, use <a>PutUserPolicy</a>. </para> <para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachUserPolicy service method.</param> <returns>The response from the AttachUserPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.AttachUserPolicyAsync(Amazon.IdentityManagement.Model.AttachUserPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachUserPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachUserPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ChangePassword(Amazon.IdentityManagement.Model.ChangePasswordRequest)"> <summary> Changes the password of the IAM user who is calling this action. The root account password is not affected by this action. <para> To change the password for a different user, see <a>UpdateLoginProfile</a>. For more information about modifying passwords, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing Passwords</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ChangePassword service method.</param> <returns>The response from the ChangePassword service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityTemporarilyUnmodifiableException"> The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidUserTypeException"> The request was rejected because the type of user for the transaction was incorrect. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.PasswordPolicyViolationException"> The request was rejected because the provided password did not meet the requirements imposed by the account password policy. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ChangePasswordAsync(Amazon.IdentityManagement.Model.ChangePasswordRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ChangePassword operation. </summary> <param name="request">Container for the necessary parameters to execute the ChangePassword operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateAccessKey"> <summary> Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is <code>Active</code>. <para> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> <para> For information about limits on the number of keys you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> <important> To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys. </important> </summary> <returns>The response from the CreateAccessKey service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateAccessKey(Amazon.IdentityManagement.Model.CreateAccessKeyRequest)"> <summary> Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is <code>Active</code>. <para> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> <para> For information about limits on the number of keys you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> <important> To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys. </important> </summary> <param name="request">Container for the necessary parameters to execute the CreateAccessKey service method.</param> <returns>The response from the CreateAccessKey service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateAccessKeyAsync(Amazon.IdentityManagement.Model.CreateAccessKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAccessKey operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAccessKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateAccountAlias(Amazon.IdentityManagement.Model.CreateAccountAliasRequest)"> <summary> Creates an alias for your AWS account. For information about using an AWS account alias, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html">Using an Alias for Your AWS Account ID</a> in the <i>IAM User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the CreateAccountAlias service method.</param> <returns>The response from the CreateAccountAlias service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateAccountAliasAsync(Amazon.IdentityManagement.Model.CreateAccountAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAccountAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAccountAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateGroup(Amazon.IdentityManagement.Model.CreateGroupRequest)"> <summary> Creates a new group. <para> For information about the number of groups you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateGroup service method.</param> <returns>The response from the CreateGroup service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateGroupAsync(Amazon.IdentityManagement.Model.CreateGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateInstanceProfile(Amazon.IdentityManagement.Model.CreateInstanceProfileRequest)"> <summary> Creates a new instance profile. For information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. <para> For information about the number of instance profiles you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateInstanceProfile service method.</param> <returns>The response from the CreateInstanceProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateInstanceProfileAsync(Amazon.IdentityManagement.Model.CreateInstanceProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateInstanceProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInstanceProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateLoginProfile(Amazon.IdentityManagement.Model.CreateLoginProfileRequest)"> <summary> Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing Passwords</a> in the <i>Using IAM</i> guide. </summary> <param name="request">Container for the necessary parameters to execute the CreateLoginProfile service method.</param> <returns>The response from the CreateLoginProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.PasswordPolicyViolationException"> The request was rejected because the provided password did not meet the requirements imposed by the account password policy. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateLoginProfileAsync(Amazon.IdentityManagement.Model.CreateLoginProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLoginProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLoginProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateOpenIDConnectProvider(Amazon.IdentityManagement.Model.CreateOpenIDConnectProviderRequest)"> <summary> Creates an IAM entity to describe an identity provider (IdP) that supports <a href="http://openid.net/connect/">OpenID Connect (OIDC)</a>. <para> The OIDC provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and the OIDC provider. </para> <para> When you create the IAM OIDC provider, you specify the URL of the OIDC identity provider (IdP) to trust, a list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider, and a list of thumbprints of the server certificate(s) that the IdP uses. You get all of this information from the OIDC IdP that you want to use for access to AWS. </para> <note>Because trust for the OIDC provider is ultimately derived from the IAM provider that this action creates, it is a best practice to limit access to the <a>CreateOpenIDConnectProvider</a> action to highly-privileged users. </note> </summary> <param name="request">Container for the necessary parameters to execute the CreateOpenIDConnectProvider service method.</param> <returns>The response from the CreateOpenIDConnectProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateOpenIDConnectProviderAsync(Amazon.IdentityManagement.Model.CreateOpenIDConnectProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateOpenIDConnectProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateOpenIDConnectProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreatePolicy(Amazon.IdentityManagement.Model.CreatePolicyRequest)"> <summary> Creates a new managed policy for your AWS account. <para> This operation creates a policy version with a version identifier of <code>v1</code> and sets v1 as the policy's default version. For more information about policy versions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </para> <para> For more information about managed policies in general, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreatePolicy service method.</param> <returns>The response from the CreatePolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreatePolicyAsync(Amazon.IdentityManagement.Model.CreatePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreatePolicyVersion(Amazon.IdentityManagement.Model.CreatePolicyVersionRequest)"> <summary> Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using <a>DeletePolicyVersion</a> before you create a new version. <para> Optionally, you can set the new version as the policy's default version. The default version is the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to. </para> <para> For more information about managed policy versions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreatePolicyVersion service method.</param> <returns>The response from the CreatePolicyVersion service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreatePolicyVersionAsync(Amazon.IdentityManagement.Model.CreatePolicyVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePolicyVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePolicyVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateRole(Amazon.IdentityManagement.Model.CreateRoleRequest)"> <summary> Creates a new role for your AWS account. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. For information about limitations on role names and the number of roles you can create, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the CreateRole service method.</param> <returns>The response from the CreateRole service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateRoleAsync(Amazon.IdentityManagement.Model.CreateRoleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateRole operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateRole operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateSAMLProvider(Amazon.IdentityManagement.Model.CreateSAMLProviderRequest)"> <summary> Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0. <para> The SAML provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and a SAML identity provider. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS. </para> <para> When you create the SAML provider, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP. </para> <note> This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note> <para> For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html">Enabling SAML 2.0 Federated Users to Access the AWS Management Console</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About SAML 2.0-based Federation</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateSAMLProvider service method.</param> <returns>The response from the CreateSAMLProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateSAMLProviderAsync(Amazon.IdentityManagement.Model.CreateSAMLProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSAMLProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSAMLProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateUser(Amazon.IdentityManagement.Model.CreateUserRequest)"> <summary> Creates a new user for your AWS account. <para> For information about limitations on the number of users you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateUser service method.</param> <returns>The response from the CreateUser service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateUserAsync(Amazon.IdentityManagement.Model.CreateUserRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateUser operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateUser operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateVirtualMFADevice(Amazon.IdentityManagement.Model.CreateVirtualMFADeviceRequest)"> <summary> Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use <a>EnableMFADevice</a> to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Using a Virtual MFA Device</a> in the <i>Using IAM</i> guide. <para> For information about limits on the number of MFA devices you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on Entities</a> in the <i>Using IAM</i> guide. </para> <important>The seed information contained in the QR code and the Base32 string should be treated like any other secret access information, such as your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures. </important> </summary> <param name="request">Container for the necessary parameters to execute the CreateVirtualMFADevice service method.</param> <returns>The response from the CreateVirtualMFADevice service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.CreateVirtualMFADeviceAsync(Amazon.IdentityManagement.Model.CreateVirtualMFADeviceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVirtualMFADevice operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVirtualMFADevice operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeactivateMFADevice(Amazon.IdentityManagement.Model.DeactivateMFADeviceRequest)"> <summary> Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled. <para> For more information about creating and working with virtual MFA devices, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Using a Virtual MFA Device</a> in the <i>Using IAM</i> guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeactivateMFADevice service method.</param> <returns>The response from the DeactivateMFADevice service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityTemporarilyUnmodifiableException"> The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeactivateMFADeviceAsync(Amazon.IdentityManagement.Model.DeactivateMFADeviceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeactivateMFADevice operation. </summary> <param name="request">Container for the necessary parameters to execute the DeactivateMFADevice operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteAccessKey(Amazon.IdentityManagement.Model.DeleteAccessKeyRequest)"> <summary> Deletes the access key associated with the specified user. <para> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccessKey service method.</param> <returns>The response from the DeleteAccessKey service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteAccessKeyAsync(Amazon.IdentityManagement.Model.DeleteAccessKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAccessKey operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccessKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteAccountAlias(Amazon.IdentityManagement.Model.DeleteAccountAliasRequest)"> <summary> Deletes the specified AWS account alias. For information about using an AWS account alias, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html">Using an Alias for Your AWS Account ID</a> in the <i>IAM User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccountAlias service method.</param> <returns>The response from the DeleteAccountAlias service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteAccountAliasAsync(Amazon.IdentityManagement.Model.DeleteAccountAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAccountAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccountAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteAccountPasswordPolicy"> <summary> Deletes the password policy for the AWS account. </summary> <returns>The response from the DeleteAccountPasswordPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteAccountPasswordPolicy(Amazon.IdentityManagement.Model.DeleteAccountPasswordPolicyRequest)"> <summary> Deletes the password policy for the AWS account. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccountPasswordPolicy service method.</param> <returns>The response from the DeleteAccountPasswordPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteAccountPasswordPolicyAsync(Amazon.IdentityManagement.Model.DeleteAccountPasswordPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAccountPasswordPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccountPasswordPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteGroup(Amazon.IdentityManagement.Model.DeleteGroupRequest)"> <summary> Deletes the specified group. The group must not contain any users or have any attached policies. </summary> <param name="request">Container for the necessary parameters to execute the DeleteGroup service method.</param> <returns>The response from the DeleteGroup service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DeleteConflictException"> The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteGroupAsync(Amazon.IdentityManagement.Model.DeleteGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteGroupPolicy(Amazon.IdentityManagement.Model.DeleteGroupPolicyRequest)"> <summary> Deletes the specified inline policy that is embedded in the specified group. <para> A group can also have managed policies attached to it. To detach a managed policy from a group, use <a>DetachGroupPolicy</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteGroupPolicy service method.</param> <returns>The response from the DeleteGroupPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteGroupPolicyAsync(Amazon.IdentityManagement.Model.DeleteGroupPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteGroupPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteGroupPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteInstanceProfile(Amazon.IdentityManagement.Model.DeleteInstanceProfileRequest)"> <summary> Deletes the specified instance profile. The instance profile must not have an associated role. <important> Make sure you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance. </important> <para> For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteInstanceProfile service method.</param> <returns>The response from the DeleteInstanceProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DeleteConflictException"> The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteInstanceProfileAsync(Amazon.IdentityManagement.Model.DeleteInstanceProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteInstanceProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInstanceProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteLoginProfile(Amazon.IdentityManagement.Model.DeleteLoginProfileRequest)"> <summary> Deletes the password for the specified user, which terminates the user's ability to access AWS services through the AWS Management Console. <important> Deleting a user's password does not prevent a user from accessing IAM through the command line interface or the API. To prevent all user access you must also either make the access key inactive or delete it. For more information about making keys inactive or deleting them, see <a>UpdateAccessKey</a> and <a>DeleteAccessKey</a>. </important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoginProfile service method.</param> <returns>The response from the DeleteLoginProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityTemporarilyUnmodifiableException"> The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteLoginProfileAsync(Amazon.IdentityManagement.Model.DeleteLoginProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLoginProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoginProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteOpenIDConnectProvider(Amazon.IdentityManagement.Model.DeleteOpenIDConnectProviderRequest)"> <summary> Deletes an IAM OpenID Connect identity provider. <para> Deleting an OIDC provider does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a provider that has been deleted will fail. </para> <para> This action is idempotent; it does not fail or return an error if you call the action for a provider that was already deleted. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteOpenIDConnectProvider service method.</param> <returns>The response from the DeleteOpenIDConnectProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteOpenIDConnectProviderAsync(Amazon.IdentityManagement.Model.DeleteOpenIDConnectProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteOpenIDConnectProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteOpenIDConnectProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeletePolicy(Amazon.IdentityManagement.Model.DeletePolicyRequest)"> <summary> Deletes the specified managed policy. <para> Before you can delete a managed policy, you must detach the policy from all users, groups, and roles that it is attached to, and you must delete all of the policy's versions. The following steps describe the process for deleting a managed policy: <ol> <li>Detach the policy from all users, groups, and roles that the policy is attached to, using the <a>DetachUserPolicy</a>, <a>DetachGroupPolicy</a>, or <a>DetachRolePolicy</a> APIs. To list all the users, groups, and roles that a policy is attached to, use <a>ListEntitiesForPolicy</a>. </li> <li>Delete all versions of the policy using <a>DeletePolicyVersion</a>. To list the policy's versions, use <a>ListPolicyVersions</a>. You cannot use <a>DeletePolicyVersion</a> to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process. </li> <li>Delete the policy (this automatically deletes the policy's default version) using this API. </li> </ol> </para> <para> For information about managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeletePolicy service method.</param> <returns>The response from the DeletePolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DeleteConflictException"> The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeletePolicyAsync(Amazon.IdentityManagement.Model.DeletePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeletePolicyVersion(Amazon.IdentityManagement.Model.DeletePolicyVersionRequest)"> <summary> Deletes the specified version of the specified managed policy. <para> You cannot delete the default version of a policy using this API. To delete the default version of a policy, use <a>DeletePolicy</a>. To find out which version of a policy is marked as the default version, use <a>ListPolicyVersions</a>. </para> <para> For information about versions for managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeletePolicyVersion service method.</param> <returns>The response from the DeletePolicyVersion service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DeleteConflictException"> The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeletePolicyVersionAsync(Amazon.IdentityManagement.Model.DeletePolicyVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePolicyVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePolicyVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteRole(Amazon.IdentityManagement.Model.DeleteRoleRequest)"> <summary> Deletes the specified role. The role must not have any policies attached. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. <important>Make sure you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance. </important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteRole service method.</param> <returns>The response from the DeleteRole service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DeleteConflictException"> The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteRoleAsync(Amazon.IdentityManagement.Model.DeleteRoleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRole operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRole operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteRolePolicy(Amazon.IdentityManagement.Model.DeleteRolePolicyRequest)"> <summary> Deletes the specified inline policy that is embedded in the specified role. <para> A role can also have managed policies attached to it. To detach a managed policy from a role, use <a>DetachRolePolicy</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteRolePolicy service method.</param> <returns>The response from the DeleteRolePolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteRolePolicyAsync(Amazon.IdentityManagement.Model.DeleteRolePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRolePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRolePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteSAMLProvider(Amazon.IdentityManagement.Model.DeleteSAMLProviderRequest)"> <summary> Deletes a SAML provider. <para> Deleting the provider does not update any roles that reference the SAML provider as a principal in their trust policies. Any attempt to assume a role that references a SAML provider that has been deleted will fail. </para> <note> This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSAMLProvider service method.</param> <returns>The response from the DeleteSAMLProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteSAMLProviderAsync(Amazon.IdentityManagement.Model.DeleteSAMLProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSAMLProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSAMLProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteServerCertificate(Amazon.IdentityManagement.Model.DeleteServerCertificateRequest)"> <summary> Deletes the specified server certificate. <para> For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with Server Certificates</a> in the <i>IAM User Guide</i>. </para> <important> If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, go to <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_DeleteLoadBalancerListeners.html">DeleteLoadBalancerListeners</a> in the <i>Elastic Load Balancing API Reference</i>. </important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteServerCertificate service method.</param> <returns>The response from the DeleteServerCertificate service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DeleteConflictException"> The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteServerCertificateAsync(Amazon.IdentityManagement.Model.DeleteServerCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteServerCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteServerCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteSigningCertificate(Amazon.IdentityManagement.Model.DeleteSigningCertificateRequest)"> <summary> Deletes the specified signing certificate associated with the specified user. <para> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSigningCertificate service method.</param> <returns>The response from the DeleteSigningCertificate service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteSigningCertificateAsync(Amazon.IdentityManagement.Model.DeleteSigningCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSigningCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSigningCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteSSHPublicKey(Amazon.IdentityManagement.Model.DeleteSSHPublicKeyRequest)"> <summary> Deletes the specified SSH public key. <para> The SSH public key deleted by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSSHPublicKey service method.</param> <returns>The response from the DeleteSSHPublicKey service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteSSHPublicKeyAsync(Amazon.IdentityManagement.Model.DeleteSSHPublicKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSSHPublicKey operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSSHPublicKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteUser(Amazon.IdentityManagement.Model.DeleteUserRequest)"> <summary> Deletes the specified user. The user must not belong to any groups, have any keys or signing certificates, or have any attached policies. </summary> <param name="request">Container for the necessary parameters to execute the DeleteUser service method.</param> <returns>The response from the DeleteUser service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DeleteConflictException"> The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteUserAsync(Amazon.IdentityManagement.Model.DeleteUserRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteUser operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteUser operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteUserPolicy(Amazon.IdentityManagement.Model.DeleteUserPolicyRequest)"> <summary> Deletes the specified inline policy that is embedded in the specified user. <para> A user can also have managed policies attached to it. To detach a managed policy from a user, use <a>DetachUserPolicy</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteUserPolicy service method.</param> <returns>The response from the DeleteUserPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteUserPolicyAsync(Amazon.IdentityManagement.Model.DeleteUserPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteUserPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteUserPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteVirtualMFADevice(Amazon.IdentityManagement.Model.DeleteVirtualMFADeviceRequest)"> <summary> Deletes a virtual MFA device. <note> You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see <a>DeactivateMFADevice</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVirtualMFADevice service method.</param> <returns>The response from the DeleteVirtualMFADevice service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DeleteConflictException"> The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DeleteVirtualMFADeviceAsync(Amazon.IdentityManagement.Model.DeleteVirtualMFADeviceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVirtualMFADevice operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVirtualMFADevice operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DetachGroupPolicy(Amazon.IdentityManagement.Model.DetachGroupPolicyRequest)"> <summary> Removes the specified managed policy from the specified group. <para> A group can also have inline policies embedded with it. To delete an inline policy, use the <a>DeleteGroupPolicy</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachGroupPolicy service method.</param> <returns>The response from the DetachGroupPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DetachGroupPolicyAsync(Amazon.IdentityManagement.Model.DetachGroupPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachGroupPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachGroupPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DetachRolePolicy(Amazon.IdentityManagement.Model.DetachRolePolicyRequest)"> <summary> Removes the specified managed policy from the specified role. <para> A role can also have inline policies embedded with it. To delete an inline policy, use the <a>DeleteRolePolicy</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachRolePolicy service method.</param> <returns>The response from the DetachRolePolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DetachRolePolicyAsync(Amazon.IdentityManagement.Model.DetachRolePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachRolePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachRolePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DetachUserPolicy(Amazon.IdentityManagement.Model.DetachUserPolicyRequest)"> <summary> Removes the specified managed policy from the specified user. <para> A user can also have inline policies embedded with it. To delete an inline policy, use the <a>DeleteUserPolicy</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachUserPolicy service method.</param> <returns>The response from the DetachUserPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.DetachUserPolicyAsync(Amazon.IdentityManagement.Model.DetachUserPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachUserPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachUserPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.EnableMFADevice(Amazon.IdentityManagement.Model.EnableMFADeviceRequest)"> <summary> Enables the specified MFA device and associates it with the specified user name. When enabled, the MFA device is required for every subsequent login by the user name associated with the device. </summary> <param name="request">Container for the necessary parameters to execute the EnableMFADevice service method.</param> <returns>The response from the EnableMFADevice service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.EntityTemporarilyUnmodifiableException"> The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidAuthenticationCodeException"> The request was rejected because the authentication code was not recognized. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.EnableMFADeviceAsync(Amazon.IdentityManagement.Model.EnableMFADeviceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableMFADevice operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableMFADevice operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GenerateCredentialReport"> <summary> Generates a credential report for the AWS account. For more information about the credential report, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting Credential Reports</a> in the <i>IAM User Guide</i>. </summary> <returns>The response from the GenerateCredentialReport service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GenerateCredentialReport(Amazon.IdentityManagement.Model.GenerateCredentialReportRequest)"> <summary> Generates a credential report for the AWS account. For more information about the credential report, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting Credential Reports</a> in the <i>IAM User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the GenerateCredentialReport service method.</param> <returns>The response from the GenerateCredentialReport service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GenerateCredentialReportAsync(Amazon.IdentityManagement.Model.GenerateCredentialReportRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GenerateCredentialReport operation. </summary> <param name="request">Container for the necessary parameters to execute the GenerateCredentialReport operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetAccessKeyLastUsed(Amazon.IdentityManagement.Model.GetAccessKeyLastUsedRequest)"> <summary> Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the AWS service and region that were specified in the last request made with that key. </summary> <param name="request">Container for the necessary parameters to execute the GetAccessKeyLastUsed service method.</param> <returns>The response from the GetAccessKeyLastUsed service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetAccessKeyLastUsedAsync(Amazon.IdentityManagement.Model.GetAccessKeyLastUsedRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetAccessKeyLastUsed operation. </summary> <param name="request">Container for the necessary parameters to execute the GetAccessKeyLastUsed operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetAccountAuthorizationDetails(Amazon.IdentityManagement.Model.GetAccountAuthorizationDetailsRequest)"> <summary> Retrieves information about all IAM users, groups, roles, and policies in your account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account. <para> You can optionally filter the results using the <code>Filter</code> parameter. You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetAccountAuthorizationDetails service method.</param> <returns>The response from the GetAccountAuthorizationDetails service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetAccountAuthorizationDetailsAsync(Amazon.IdentityManagement.Model.GetAccountAuthorizationDetailsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetAccountAuthorizationDetails operation. </summary> <param name="request">Container for the necessary parameters to execute the GetAccountAuthorizationDetails operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetAccountPasswordPolicy"> <summary> Retrieves the password policy for the AWS account. For more information about using a password policy, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html">Managing an IAM Password Policy</a>. </summary> <returns>The response from the GetAccountPasswordPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetAccountPasswordPolicy(Amazon.IdentityManagement.Model.GetAccountPasswordPolicyRequest)"> <summary> Retrieves the password policy for the AWS account. For more information about using a password policy, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html">Managing an IAM Password Policy</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetAccountPasswordPolicy service method.</param> <returns>The response from the GetAccountPasswordPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetAccountPasswordPolicyAsync(Amazon.IdentityManagement.Model.GetAccountPasswordPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetAccountPasswordPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetAccountPasswordPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetAccountSummary"> <summary> Retrieves information about IAM entity usage and IAM quotas in the AWS account. <para> For information about limitations on IAM entities, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> </summary> <returns>The response from the GetAccountSummary service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetAccountSummary(Amazon.IdentityManagement.Model.GetAccountSummaryRequest)"> <summary> Retrieves information about IAM entity usage and IAM quotas in the AWS account. <para> For information about limitations on IAM entities, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetAccountSummary service method.</param> <returns>The response from the GetAccountSummary service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetAccountSummaryAsync(Amazon.IdentityManagement.Model.GetAccountSummaryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetAccountSummary operation. </summary> <param name="request">Container for the necessary parameters to execute the GetAccountSummary operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetContextKeysForCustomPolicy(System.Collections.Generic.List{System.String})"> <summary> Gets a list of all of the context keys referenced in <code>Condition</code> elements in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use <a>GetContextKeysForPrincipalPolicy</a>. <para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the <code>Condition</code> element of an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call <a>SimulateCustomPolicy</a>. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request. </para> </summary> <param name="policyInputList">A list of policies for which you want list of context keys used in <code>Condition</code> elements. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.</param> <returns>The response from the GetContextKeysForCustomPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetContextKeysForCustomPolicy(Amazon.IdentityManagement.Model.GetContextKeysForCustomPolicyRequest)"> <summary> Gets a list of all of the context keys referenced in <code>Condition</code> elements in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use <a>GetContextKeysForPrincipalPolicy</a>. <para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the <code>Condition</code> element of an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call <a>SimulateCustomPolicy</a>. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetContextKeysForCustomPolicy service method.</param> <returns>The response from the GetContextKeysForCustomPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetContextKeysForCustomPolicyAsync(Amazon.IdentityManagement.Model.GetContextKeysForCustomPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetContextKeysForCustomPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetContextKeysForCustomPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetContextKeysForPrincipalPolicy(System.String)"> <summary> Gets a list of all of the context keys referenced in <code>Condition</code> elements in all of the IAM policies attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of. <para> You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use <a>GetContextKeysForCustomPolicy</a> instead. </para> <para> <b>Note:</b> This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use <a>GetContextKeysForCustomPolicy</a> instead. </para> <para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the <code>Condition</code> element of an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call <a>SimulatePrincipalPolicy</a>. </para> </summary> <param name="policySourceArn">The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.</param> <returns>The response from the GetContextKeysForPrincipalPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetContextKeysForPrincipalPolicy(System.String,System.Collections.Generic.List{System.String})"> <summary> Gets a list of all of the context keys referenced in <code>Condition</code> elements in all of the IAM policies attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of. <para> You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use <a>GetContextKeysForCustomPolicy</a> instead. </para> <para> <b>Note:</b> This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use <a>GetContextKeysForCustomPolicy</a> instead. </para> <para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the <code>Condition</code> element of an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call <a>SimulatePrincipalPolicy</a>. </para> </summary> <param name="policySourceArn">The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.</param> <param name="policyInputList">A optional list of additional policies for which you want list of context keys used in <code>Condition</code> elements.</param> <returns>The response from the GetContextKeysForPrincipalPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetContextKeysForPrincipalPolicy(Amazon.IdentityManagement.Model.GetContextKeysForPrincipalPolicyRequest)"> <summary> Gets a list of all of the context keys referenced in <code>Condition</code> elements in all of the IAM policies attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of. <para> You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use <a>GetContextKeysForCustomPolicy</a> instead. </para> <para> <b>Note:</b> This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use <a>GetContextKeysForCustomPolicy</a> instead. </para> <para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the <code>Condition</code> element of an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call <a>SimulatePrincipalPolicy</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetContextKeysForPrincipalPolicy service method.</param> <returns>The response from the GetContextKeysForPrincipalPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetContextKeysForPrincipalPolicyAsync(Amazon.IdentityManagement.Model.GetContextKeysForPrincipalPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetContextKeysForPrincipalPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetContextKeysForPrincipalPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetCredentialReport"> <summary> Retrieves a credential report for the AWS account. For more information about the credential report, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting Credential Reports</a> in the <i>IAM User Guide</i>. </summary> <returns>The response from the GetCredentialReport service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.CredentialReportExpiredException"> The request was rejected because the most recent credential report has expired. To generate a new credential report, use <a>GenerateCredentialReport</a>. For more information about credential report expiration, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting Credential Reports</a> in the <i>IAM User Guide</i>. </exception> <exception cref="T:Amazon.IdentityManagement.Model.CredentialReportNotPresentException"> The request was rejected because the credential report does not exist. To generate a credential report, use <a>GenerateCredentialReport</a>. </exception> <exception cref="T:Amazon.IdentityManagement.Model.CredentialReportNotReadyException"> The request was rejected because the credential report is still being generated. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetCredentialReport(Amazon.IdentityManagement.Model.GetCredentialReportRequest)"> <summary> Retrieves a credential report for the AWS account. For more information about the credential report, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting Credential Reports</a> in the <i>IAM User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the GetCredentialReport service method.</param> <returns>The response from the GetCredentialReport service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.CredentialReportExpiredException"> The request was rejected because the most recent credential report has expired. To generate a new credential report, use <a>GenerateCredentialReport</a>. For more information about credential report expiration, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting Credential Reports</a> in the <i>IAM User Guide</i>. </exception> <exception cref="T:Amazon.IdentityManagement.Model.CredentialReportNotPresentException"> The request was rejected because the credential report does not exist. To generate a credential report, use <a>GenerateCredentialReport</a>. </exception> <exception cref="T:Amazon.IdentityManagement.Model.CredentialReportNotReadyException"> The request was rejected because the credential report is still being generated. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetCredentialReportAsync(Amazon.IdentityManagement.Model.GetCredentialReportRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetCredentialReport operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCredentialReport operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetGroup(Amazon.IdentityManagement.Model.GetGroupRequest)"> <summary> Returns a list of users that are in the specified group. You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </summary> <param name="request">Container for the necessary parameters to execute the GetGroup service method.</param> <returns>The response from the GetGroup service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetGroupAsync(Amazon.IdentityManagement.Model.GetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the GetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetGroupPolicy(Amazon.IdentityManagement.Model.GetGroupPolicyRequest)"> <summary> Retrieves the specified inline policy document that is embedded in the specified group. <para> A group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document. </para> <para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetGroupPolicy service method.</param> <returns>The response from the GetGroupPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetGroupPolicyAsync(Amazon.IdentityManagement.Model.GetGroupPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetGroupPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetGroupPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetInstanceProfile(Amazon.IdentityManagement.Model.GetInstanceProfileRequest)"> <summary> Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. For more information about ARNs, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_ARNs">ARNs</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetInstanceProfile service method.</param> <returns>The response from the GetInstanceProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetInstanceProfileAsync(Amazon.IdentityManagement.Model.GetInstanceProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetInstanceProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the GetInstanceProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetLoginProfile(Amazon.IdentityManagement.Model.GetLoginProfileRequest)"> <summary> Retrieves the user name and password-creation date for the specified user. If the user has not been assigned a password, the action returns a 404 (<code>NoSuchEntity</code>) error. </summary> <param name="request">Container for the necessary parameters to execute the GetLoginProfile service method.</param> <returns>The response from the GetLoginProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetLoginProfileAsync(Amazon.IdentityManagement.Model.GetLoginProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetLoginProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the GetLoginProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetOpenIDConnectProvider(Amazon.IdentityManagement.Model.GetOpenIDConnectProviderRequest)"> <summary> Returns information about the specified OpenID Connect provider. </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIDConnectProvider service method.</param> <returns>The response from the GetOpenIDConnectProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetOpenIDConnectProviderAsync(Amazon.IdentityManagement.Model.GetOpenIDConnectProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetOpenIDConnectProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIDConnectProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetPolicy(Amazon.IdentityManagement.Model.GetPolicyRequest)"> <summary> Retrieves information about the specified managed policy, including the policy's default version and the total number of users, groups, and roles that the policy is attached to. For a list of the specific users, groups, and roles that the policy is attached to, use the <a>ListEntitiesForPolicy</a> API. This API returns metadata about the policy. To retrieve the policy document for a specific version of the policy, use <a>GetPolicyVersion</a>. <para> This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with a user, group, or role, use the <a>GetUserPolicy</a>, <a>GetGroupPolicy</a>, or <a>GetRolePolicy</a> API. </para> <para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetPolicy service method.</param> <returns>The response from the GetPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetPolicyAsync(Amazon.IdentityManagement.Model.GetPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetPolicyVersion(Amazon.IdentityManagement.Model.GetPolicyVersionRequest)"> <summary> Retrieves information about the specified version of the specified managed policy, including the policy document. <para> To list the available versions for a policy, use <a>ListPolicyVersions</a>. </para> <para> This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use the <a>GetUserPolicy</a>, <a>GetGroupPolicy</a>, or <a>GetRolePolicy</a> API. </para> <para> For more information about the types of policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetPolicyVersion service method.</param> <returns>The response from the GetPolicyVersion service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetPolicyVersionAsync(Amazon.IdentityManagement.Model.GetPolicyVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetPolicyVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPolicyVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetRole(Amazon.IdentityManagement.Model.GetRoleRequest)"> <summary> Retrieves information about the specified role, including the role's path, GUID, ARN, and the policy granting permission to assume the role. For more information about ARNs, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_ARNs">ARNs</a>. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetRole service method.</param> <returns>The response from the GetRole service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetRoleAsync(Amazon.IdentityManagement.Model.GetRoleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetRole operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRole operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetRolePolicy(Amazon.IdentityManagement.Model.GetRolePolicyRequest)"> <summary> Retrieves the specified inline policy document that is embedded with the specified role. <para> A role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document. </para> <para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using Roles to Delegate Permissions and Federate Identities</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetRolePolicy service method.</param> <returns>The response from the GetRolePolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetRolePolicyAsync(Amazon.IdentityManagement.Model.GetRolePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetRolePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRolePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetSAMLProvider(Amazon.IdentityManagement.Model.GetSAMLProviderRequest)"> <summary> Returns the SAML provider metadocument that was uploaded when the provider was created or updated. <note>This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the GetSAMLProvider service method.</param> <returns>The response from the GetSAMLProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetSAMLProviderAsync(Amazon.IdentityManagement.Model.GetSAMLProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSAMLProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSAMLProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetServerCertificate(Amazon.IdentityManagement.Model.GetServerCertificateRequest)"> <summary> Retrieves information about the specified server certificate. <para> For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with Server Certificates</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetServerCertificate service method.</param> <returns>The response from the GetServerCertificate service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetServerCertificateAsync(Amazon.IdentityManagement.Model.GetServerCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetServerCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the GetServerCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetSSHPublicKey(Amazon.IdentityManagement.Model.GetSSHPublicKeyRequest)"> <summary> Retrieves the specified SSH public key, including metadata about the key. <para> The SSH public key retrieved by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetSSHPublicKey service method.</param> <returns>The response from the GetSSHPublicKey service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.UnrecognizedPublicKeyEncodingException"> The request was rejected because the public key encoding format is unsupported or unrecognized. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetSSHPublicKeyAsync(Amazon.IdentityManagement.Model.GetSSHPublicKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSSHPublicKey operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSSHPublicKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetUser"> <summary> Retrieves information about the specified user, including the user's creation date, path, unique ID, and ARN. <para> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request. </para> </summary> <returns>The response from the GetUser service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetUser(Amazon.IdentityManagement.Model.GetUserRequest)"> <summary> Retrieves information about the specified user, including the user's creation date, path, unique ID, and ARN. <para> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetUser service method.</param> <returns>The response from the GetUser service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetUserAsync(Amazon.IdentityManagement.Model.GetUserRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetUser operation. </summary> <param name="request">Container for the necessary parameters to execute the GetUser operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetUserPolicy(Amazon.IdentityManagement.Model.GetUserPolicyRequest)"> <summary> Retrieves the specified inline policy document that is embedded in the specified user. <para> A user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document. </para> <para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetUserPolicy service method.</param> <returns>The response from the GetUserPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.GetUserPolicyAsync(Amazon.IdentityManagement.Model.GetUserPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetUserPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetUserPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListAccessKeys"> <summary> Returns information about the access key IDs associated with the specified user. If there are none, the action returns an empty list. <para> Although each user is limited to a small number of keys, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> <para> If the <code>UserName</code> field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> <note>To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. </note> </summary> <returns>The response from the ListAccessKeys service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListAccessKeys(Amazon.IdentityManagement.Model.ListAccessKeysRequest)"> <summary> Returns information about the access key IDs associated with the specified user. If there are none, the action returns an empty list. <para> Although each user is limited to a small number of keys, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> <para> If the <code>UserName</code> field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> <note>To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. </note> </summary> <param name="request">Container for the necessary parameters to execute the ListAccessKeys service method.</param> <returns>The response from the ListAccessKeys service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListAccessKeysAsync(Amazon.IdentityManagement.Model.ListAccessKeysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAccessKeys operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAccessKeys operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListAccountAliases"> <summary> Lists the account alias associated with the account (Note: you can have only one). For information about using an AWS account alias, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html">Using an Alias for Your AWS Account ID</a> in the <i>IAM User Guide</i>. </summary> <returns>The response from the ListAccountAliases service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListAccountAliases(Amazon.IdentityManagement.Model.ListAccountAliasesRequest)"> <summary> Lists the account alias associated with the account (Note: you can have only one). For information about using an AWS account alias, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html">Using an Alias for Your AWS Account ID</a> in the <i>IAM User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ListAccountAliases service method.</param> <returns>The response from the ListAccountAliases service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListAccountAliasesAsync(Amazon.IdentityManagement.Model.ListAccountAliasesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAccountAliases operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAccountAliases operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListAttachedGroupPolicies(Amazon.IdentityManagement.Model.ListAttachedGroupPoliciesRequest)"> <summary> Lists all managed policies that are attached to the specified group. <para> A group can also have inline policies embedded with it. To list the inline policies for a group, use the <a>ListGroupPolicies</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. You can use the <code>PathPrefix</code> parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListAttachedGroupPolicies service method.</param> <returns>The response from the ListAttachedGroupPolicies service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListAttachedGroupPoliciesAsync(Amazon.IdentityManagement.Model.ListAttachedGroupPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAttachedGroupPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAttachedGroupPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListAttachedRolePolicies(Amazon.IdentityManagement.Model.ListAttachedRolePoliciesRequest)"> <summary> Lists all managed policies that are attached to the specified role. <para> A role can also have inline policies embedded with it. To list the inline policies for a role, use the <a>ListRolePolicies</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. You can use the <code>PathPrefix</code> parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the action returns an empty list. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListAttachedRolePolicies service method.</param> <returns>The response from the ListAttachedRolePolicies service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListAttachedRolePoliciesAsync(Amazon.IdentityManagement.Model.ListAttachedRolePoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAttachedRolePolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAttachedRolePolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListAttachedUserPolicies(Amazon.IdentityManagement.Model.ListAttachedUserPoliciesRequest)"> <summary> Lists all managed policies that are attached to the specified user. <para> A user can also have inline policies embedded with it. To list the inline policies for a user, use the <a>ListUserPolicies</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. You can use the <code>PathPrefix</code> parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListAttachedUserPolicies service method.</param> <returns>The response from the ListAttachedUserPolicies service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListAttachedUserPoliciesAsync(Amazon.IdentityManagement.Model.ListAttachedUserPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAttachedUserPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAttachedUserPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListEntitiesForPolicy(Amazon.IdentityManagement.Model.ListEntitiesForPolicyRequest)"> <summary> Lists all users, groups, and roles that the specified managed policy is attached to. <para> You can use the optional <code>EntityFilter</code> parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set <code>EntityFilter</code> to <code>Role</code>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListEntitiesForPolicy service method.</param> <returns>The response from the ListEntitiesForPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListEntitiesForPolicyAsync(Amazon.IdentityManagement.Model.ListEntitiesForPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListEntitiesForPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the ListEntitiesForPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListGroupPolicies(Amazon.IdentityManagement.Model.ListGroupPoliciesRequest)"> <summary> Lists the names of the inline policies that are embedded in the specified group. <para> A group can also have managed policies attached to it. To list the managed policies that are attached to a group, use <a>ListAttachedGroupPolicies</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified group, the action returns an empty list. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListGroupPolicies service method.</param> <returns>The response from the ListGroupPolicies service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListGroupPoliciesAsync(Amazon.IdentityManagement.Model.ListGroupPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListGroupPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListGroupPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListGroups"> <summary> Lists the groups that have the specified path prefix. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <returns>The response from the ListGroups service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListGroups(Amazon.IdentityManagement.Model.ListGroupsRequest)"> <summary> Lists the groups that have the specified path prefix. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListGroups service method.</param> <returns>The response from the ListGroups service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListGroupsAsync(Amazon.IdentityManagement.Model.ListGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the ListGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListGroupsForUser(Amazon.IdentityManagement.Model.ListGroupsForUserRequest)"> <summary> Lists the groups the specified user belongs to. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListGroupsForUser service method.</param> <returns>The response from the ListGroupsForUser service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListGroupsForUserAsync(Amazon.IdentityManagement.Model.ListGroupsForUserRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListGroupsForUser operation. </summary> <param name="request">Container for the necessary parameters to execute the ListGroupsForUser operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListInstanceProfiles"> <summary> Lists the instance profiles that have the specified path prefix. If there are none, the action returns an empty list. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <returns>The response from the ListInstanceProfiles service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListInstanceProfiles(Amazon.IdentityManagement.Model.ListInstanceProfilesRequest)"> <summary> Lists the instance profiles that have the specified path prefix. If there are none, the action returns an empty list. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceProfiles service method.</param> <returns>The response from the ListInstanceProfiles service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListInstanceProfilesAsync(Amazon.IdentityManagement.Model.ListInstanceProfilesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListInstanceProfiles operation. </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceProfiles operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListInstanceProfilesForRole(Amazon.IdentityManagement.Model.ListInstanceProfilesForRoleRequest)"> <summary> Lists the instance profiles that have the specified associated role. If there are none, the action returns an empty list. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceProfilesForRole service method.</param> <returns>The response from the ListInstanceProfilesForRole service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListInstanceProfilesForRoleAsync(Amazon.IdentityManagement.Model.ListInstanceProfilesForRoleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListInstanceProfilesForRole operation. </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceProfilesForRole operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListMFADevices"> <summary> Lists the MFA devices. If the request includes the user name, then this action lists all the MFA devices associated with the specified user name. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <returns>The response from the ListMFADevices service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListMFADevices(Amazon.IdentityManagement.Model.ListMFADevicesRequest)"> <summary> Lists the MFA devices. If the request includes the user name, then this action lists all the MFA devices associated with the specified user name. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListMFADevices service method.</param> <returns>The response from the ListMFADevices service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListMFADevicesAsync(Amazon.IdentityManagement.Model.ListMFADevicesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListMFADevices operation. </summary> <param name="request">Container for the necessary parameters to execute the ListMFADevices operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListOpenIDConnectProviders(Amazon.IdentityManagement.Model.ListOpenIDConnectProvidersRequest)"> <summary> Lists information about the OpenID Connect providers in the AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListOpenIDConnectProviders service method.</param> <returns>The response from the ListOpenIDConnectProviders service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListOpenIDConnectProvidersAsync(Amazon.IdentityManagement.Model.ListOpenIDConnectProvidersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListOpenIDConnectProviders operation. </summary> <param name="request">Container for the necessary parameters to execute the ListOpenIDConnectProviders operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListPolicies"> <summary> Lists all the managed policies that are available to your account, including your own customer managed policies and all AWS managed policies. <para> You can filter the list of policies that is returned using the optional <code>OnlyAttached</code>, <code>Scope</code>, and <code>PathPrefix</code> parameters. For example, to list only the customer managed policies in your AWS account, set <code>Scope</code> to <code>Local</code>. To list only AWS managed policies, set <code>Scope</code> to <code>AWS</code>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> <para> For more information about managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <returns>The response from the ListPolicies service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListPolicies(Amazon.IdentityManagement.Model.ListPoliciesRequest)"> <summary> Lists all the managed policies that are available to your account, including your own customer managed policies and all AWS managed policies. <para> You can filter the list of policies that is returned using the optional <code>OnlyAttached</code>, <code>Scope</code>, and <code>PathPrefix</code> parameters. For example, to list only the customer managed policies in your AWS account, set <code>Scope</code> to <code>Local</code>. To list only AWS managed policies, set <code>Scope</code> to <code>AWS</code>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> <para> For more information about managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListPolicies service method.</param> <returns>The response from the ListPolicies service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListPoliciesAsync(Amazon.IdentityManagement.Model.ListPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListPolicyVersions(Amazon.IdentityManagement.Model.ListPolicyVersionsRequest)"> <summary> Lists information about the versions of the specified managed policy, including the version that is set as the policy's default version. <para> For more information about managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListPolicyVersions service method.</param> <returns>The response from the ListPolicyVersions service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListPolicyVersionsAsync(Amazon.IdentityManagement.Model.ListPolicyVersionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListPolicyVersions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPolicyVersions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListRolePolicies(Amazon.IdentityManagement.Model.ListRolePoliciesRequest)"> <summary> Lists the names of the inline policies that are embedded in the specified role. <para> A role can also have managed policies attached to it. To list the managed policies that are attached to a role, use <a>ListAttachedRolePolicies</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified role, the action returns an empty list. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListRolePolicies service method.</param> <returns>The response from the ListRolePolicies service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListRolePoliciesAsync(Amazon.IdentityManagement.Model.ListRolePoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListRolePolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRolePolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListRoles"> <summary> Lists the roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <returns>The response from the ListRoles service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListRoles(Amazon.IdentityManagement.Model.ListRolesRequest)"> <summary> Lists the roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListRoles service method.</param> <returns>The response from the ListRoles service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListRolesAsync(Amazon.IdentityManagement.Model.ListRolesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListRoles operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRoles operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListSAMLProviders"> <summary> Lists the SAML providers in the account. <note> This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note> </summary> <returns>The response from the ListSAMLProviders service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListSAMLProviders(Amazon.IdentityManagement.Model.ListSAMLProvidersRequest)"> <summary> Lists the SAML providers in the account. <note> This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the ListSAMLProviders service method.</param> <returns>The response from the ListSAMLProviders service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListSAMLProvidersAsync(Amazon.IdentityManagement.Model.ListSAMLProvidersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListSAMLProviders operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSAMLProviders operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListServerCertificates"> <summary> Lists the server certificates that have the specified path prefix. If none exist, the action returns an empty list. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> <para> For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with Server Certificates</a> in the <i>IAM User Guide</i>. </para> </summary> <returns>The response from the ListServerCertificates service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListServerCertificates(Amazon.IdentityManagement.Model.ListServerCertificatesRequest)"> <summary> Lists the server certificates that have the specified path prefix. If none exist, the action returns an empty list. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> <para> For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with Server Certificates</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListServerCertificates service method.</param> <returns>The response from the ListServerCertificates service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListServerCertificatesAsync(Amazon.IdentityManagement.Model.ListServerCertificatesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListServerCertificates operation. </summary> <param name="request">Container for the necessary parameters to execute the ListServerCertificates operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListSigningCertificates"> <summary> Returns information about the signing certificates associated with the specified user. If there are none, the action returns an empty list. <para> Although each user is limited to a small number of signing certificates, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> <para> If the <code>UserName</code> field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> </summary> <returns>The response from the ListSigningCertificates service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListSigningCertificates(Amazon.IdentityManagement.Model.ListSigningCertificatesRequest)"> <summary> Returns information about the signing certificates associated with the specified user. If there are none, the action returns an empty list. <para> Although each user is limited to a small number of signing certificates, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> <para> If the <code>UserName</code> field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListSigningCertificates service method.</param> <returns>The response from the ListSigningCertificates service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListSigningCertificatesAsync(Amazon.IdentityManagement.Model.ListSigningCertificatesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListSigningCertificates operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSigningCertificates operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListSSHPublicKeys(Amazon.IdentityManagement.Model.ListSSHPublicKeysRequest)"> <summary> Returns information about the SSH public keys associated with the specified IAM user. If there are none, the action returns an empty list. <para> The SSH public keys returned by this action are used only for authenticating the IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>. </para> <para> Although each user is limited to a small number of keys, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListSSHPublicKeys service method.</param> <returns>The response from the ListSSHPublicKeys service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListSSHPublicKeysAsync(Amazon.IdentityManagement.Model.ListSSHPublicKeysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListSSHPublicKeys operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSSHPublicKeys operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListUserPolicies(Amazon.IdentityManagement.Model.ListUserPoliciesRequest)"> <summary> Lists the names of the inline policies embedded in the specified user. <para> A user can also have managed policies attached to it. To list the managed policies that are attached to a user, use <a>ListAttachedUserPolicies</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified user, the action returns an empty list. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListUserPolicies service method.</param> <returns>The response from the ListUserPolicies service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListUserPoliciesAsync(Amazon.IdentityManagement.Model.ListUserPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListUserPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListUserPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListUsers"> <summary> Lists the IAM users that have the specified path prefix. If no path prefix is specified, the action returns all users in the AWS account. If there are none, the action returns an empty list. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <returns>The response from the ListUsers service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListUsers(Amazon.IdentityManagement.Model.ListUsersRequest)"> <summary> Lists the IAM users that have the specified path prefix. If no path prefix is specified, the action returns all users in the AWS account. If there are none, the action returns an empty list. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListUsers service method.</param> <returns>The response from the ListUsers service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListUsersAsync(Amazon.IdentityManagement.Model.ListUsersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListUsers operation. </summary> <param name="request">Container for the necessary parameters to execute the ListUsers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListVirtualMFADevices"> <summary> Lists the virtual MFA devices under the AWS account by assignment status. If you do not specify an assignment status, the action returns a list of all virtual MFA devices. Assignment status can be <code>Assigned</code>, <code>Unassigned</code>, or <code>Any</code>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <returns>The response from the ListVirtualMFADevices service method, as returned by IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListVirtualMFADevices(Amazon.IdentityManagement.Model.ListVirtualMFADevicesRequest)"> <summary> Lists the virtual MFA devices under the AWS account by assignment status. If you do not specify an assignment status, the action returns a list of all virtual MFA devices. Assignment status can be <code>Assigned</code>, <code>Unassigned</code>, or <code>Any</code>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListVirtualMFADevices service method.</param> <returns>The response from the ListVirtualMFADevices service method, as returned by IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ListVirtualMFADevicesAsync(Amazon.IdentityManagement.Model.ListVirtualMFADevicesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListVirtualMFADevices operation. </summary> <param name="request">Container for the necessary parameters to execute the ListVirtualMFADevices operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.PutGroupPolicy(Amazon.IdentityManagement.Model.PutGroupPolicyRequest)"> <summary> Adds (or updates) an inline policy document that is embedded in the specified group. <para> A user can also have managed policies attached to it. To attach a managed policy to a group, use <a>AttachGroupPolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> For information about limits on the number of inline policies that you can embed in a group, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutGroupPolicy</code>. For general information about using the Query API with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in the <i>Using IAM</i> guide. </note> </summary> <param name="request">Container for the necessary parameters to execute the PutGroupPolicy service method.</param> <returns>The response from the PutGroupPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.PutGroupPolicyAsync(Amazon.IdentityManagement.Model.PutGroupPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutGroupPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutGroupPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.PutRolePolicy(Amazon.IdentityManagement.Model.PutRolePolicyRequest)"> <summary> Adds (or updates) an inline policy document that is embedded in the specified role. <para> When you embed an inline policy in a role, the inline policy is used as the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using <a>CreateRole</a>. You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using Roles to Delegate Permissions and Federate Identities</a>. </para> <para> A role can also have a managed policy attached to it. To attach a managed policy to a role, use <a>AttachRolePolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> For information about limits on the number of inline policies that you can embed with a role, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutRolePolicy</code>. For general information about using the Query API with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in the <i>Using IAM</i> guide. </note> </summary> <param name="request">Container for the necessary parameters to execute the PutRolePolicy service method.</param> <returns>The response from the PutRolePolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.PutRolePolicyAsync(Amazon.IdentityManagement.Model.PutRolePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutRolePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutRolePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.PutUserPolicy(Amazon.IdentityManagement.Model.PutUserPolicyRequest)"> <summary> Adds (or updates) an inline policy document that is embedded in the specified user. <para> A user can also have a managed policy attached to it. To attach a managed policy to a user, use <a>AttachUserPolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> For information about limits on the number of inline policies that you can embed in a user, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutUserPolicy</code>. For general information about using the Query API with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in the <i>Using IAM</i> guide. </note> </summary> <param name="request">Container for the necessary parameters to execute the PutUserPolicy service method.</param> <returns>The response from the PutUserPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.PutUserPolicyAsync(Amazon.IdentityManagement.Model.PutUserPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutUserPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutUserPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.RemoveClientIDFromOpenIDConnectProvider(Amazon.IdentityManagement.Model.RemoveClientIDFromOpenIDConnectProviderRequest)"> <summary> Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect provider. <para> This action is idempotent; it does not fail or return an error if you try to remove a client ID that was removed previously. </para> </summary> <param name="request">Container for the necessary parameters to execute the RemoveClientIDFromOpenIDConnectProvider service method.</param> <returns>The response from the RemoveClientIDFromOpenIDConnectProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.RemoveClientIDFromOpenIDConnectProviderAsync(Amazon.IdentityManagement.Model.RemoveClientIDFromOpenIDConnectProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveClientIDFromOpenIDConnectProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveClientIDFromOpenIDConnectProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.RemoveRoleFromInstanceProfile(Amazon.IdentityManagement.Model.RemoveRoleFromInstanceProfileRequest)"> <summary> Removes the specified role from the specified instance profile. <important> Make sure you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance will break any applications running on the instance. </important> <para> For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RemoveRoleFromInstanceProfile service method.</param> <returns>The response from the RemoveRoleFromInstanceProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.RemoveRoleFromInstanceProfileAsync(Amazon.IdentityManagement.Model.RemoveRoleFromInstanceProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveRoleFromInstanceProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveRoleFromInstanceProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.RemoveUserFromGroup(Amazon.IdentityManagement.Model.RemoveUserFromGroupRequest)"> <summary> Removes the specified user from the specified group. </summary> <param name="request">Container for the necessary parameters to execute the RemoveUserFromGroup service method.</param> <returns>The response from the RemoveUserFromGroup service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.RemoveUserFromGroupAsync(Amazon.IdentityManagement.Model.RemoveUserFromGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveUserFromGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveUserFromGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ResyncMFADevice(Amazon.IdentityManagement.Model.ResyncMFADeviceRequest)"> <summary> Synchronizes the specified MFA device with AWS servers. <para> For more information about creating and working with virtual MFA devices, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Using a Virtual MFA Device</a> in the <i>Using IAM</i> guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the ResyncMFADevice service method.</param> <returns>The response from the ResyncMFADevice service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidAuthenticationCodeException"> The request was rejected because the authentication code was not recognized. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.ResyncMFADeviceAsync(Amazon.IdentityManagement.Model.ResyncMFADeviceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResyncMFADevice operation. </summary> <param name="request">Container for the necessary parameters to execute the ResyncMFADevice operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.SetDefaultPolicyVersion(Amazon.IdentityManagement.Model.SetDefaultPolicyVersionRequest)"> <summary> Sets the specified version of the specified policy as the policy's default (operative) version. <para> This action affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use the <a>ListEntitiesForPolicy</a> API. </para> <para> For information about managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetDefaultPolicyVersion service method.</param> <returns>The response from the SetDefaultPolicyVersion service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.SetDefaultPolicyVersionAsync(Amazon.IdentityManagement.Model.SetDefaultPolicyVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetDefaultPolicyVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the SetDefaultPolicyVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.SimulateCustomPolicy(Amazon.IdentityManagement.Model.SimulateCustomPolicyRequest)"> <summary> Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and AWS resources to determine the policies' effective permissions. The policies are provided as strings. <para> The simulation does not perform the API actions; it only checks the authorization to determine if the simulated policies allow or deny the actions. </para> <para> If you want to simulate existing policies attached to an IAM user, group, or role, use <a>SimulatePrincipalPolicy</a> instead. </para> <para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the <code>Condition</code> element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use <a>GetContextKeysForCustomPolicy</a>. </para> <para> If the output is long, you can use <code>MaxItems</code> and <code>Marker</code> parameters to paginate the results. </para> </summary> <param name="request">Container for the necessary parameters to execute the SimulateCustomPolicy service method.</param> <returns>The response from the SimulateCustomPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.PolicyEvaluationException"> The request failed because a provided policy could not be successfully evaluated. An additional detail message indicates the source of the failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.SimulateCustomPolicyAsync(Amazon.IdentityManagement.Model.SimulateCustomPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SimulateCustomPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the SimulateCustomPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.SimulatePrincipalPolicy(Amazon.IdentityManagement.Model.SimulatePrincipalPolicyRequest)"> <summary> Simulate how a set of IAM policies attached to an IAM entity works with a list of API actions and AWS resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to . <para> You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use <a>SimulateCustomPolicy</a> instead. </para> <para> You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation. </para> <para> The simulation does not perform the API actions, it only checks the authorization to determine if the simulated policies allow or deny the actions. </para> <para> <b>Note:</b> This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use <a>SimulateCustomPolicy</a> instead. </para> <para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the <code>Condition</code> element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use <a>GetContextKeysForPrincipalPolicy</a>. </para> <para> If the output is long, you can use the <code>MaxItems</code> and <code>Marker</code> parameters to paginate the results. </para> </summary> <param name="request">Container for the necessary parameters to execute the SimulatePrincipalPolicy service method.</param> <returns>The response from the SimulatePrincipalPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.PolicyEvaluationException"> The request failed because a provided policy could not be successfully evaluated. An additional detail message indicates the source of the failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.SimulatePrincipalPolicyAsync(Amazon.IdentityManagement.Model.SimulatePrincipalPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SimulatePrincipalPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the SimulatePrincipalPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateAccessKey(Amazon.IdentityManagement.Model.UpdateAccessKeyRequest)"> <summary> Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user's key as part of a key rotation work flow. <para> If the <code>UserName</code> field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> <para> For information about rotating keys, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html">Managing Keys and Certificates</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAccessKey service method.</param> <returns>The response from the UpdateAccessKey service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateAccessKeyAsync(Amazon.IdentityManagement.Model.UpdateAccessKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAccessKey operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAccessKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateAccountPasswordPolicy"> <summary> Updates the password policy settings for the AWS account. <note> <para> This action does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the <b>Request Parameters</b> section for each parameter's default value. </para> </note> <para> For more information about using a password policy, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html">Managing an IAM Password Policy</a> in the <i>IAM User Guide</i>. </para> </summary> <returns>The response from the UpdateAccountPasswordPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateAccountPasswordPolicy(Amazon.IdentityManagement.Model.UpdateAccountPasswordPolicyRequest)"> <summary> Updates the password policy settings for the AWS account. <note> <para> This action does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the <b>Request Parameters</b> section for each parameter's default value. </para> </note> <para> For more information about using a password policy, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html">Managing an IAM Password Policy</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAccountPasswordPolicy service method.</param> <returns>The response from the UpdateAccountPasswordPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateAccountPasswordPolicyAsync(Amazon.IdentityManagement.Model.UpdateAccountPasswordPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAccountPasswordPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAccountPasswordPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateAssumeRolePolicy(Amazon.IdentityManagement.Model.UpdateAssumeRolePolicyRequest)"> <summary> Updates the policy that grants an entity permission to assume a role. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using Roles to Delegate Permissions and Federate Identities</a>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAssumeRolePolicy service method.</param> <returns>The response from the UpdateAssumeRolePolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateAssumeRolePolicyAsync(Amazon.IdentityManagement.Model.UpdateAssumeRolePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAssumeRolePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAssumeRolePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateGroup(Amazon.IdentityManagement.Model.UpdateGroupRequest)"> <summary> Updates the name and/or the path of the specified group. <important> You should understand the implications of changing a group's path or name. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html">Renaming Users and Groups</a> in the <i>IAM User Guide</i>. </important> <note>To change a group name the requester must have appropriate permissions on both the source object and the target object. For example, to change Managers to MGRs, the entity making the request must have permission on Managers and MGRs, or must have permission on all (*). For more information about permissions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html" target="blank">Permissions and Policies</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateGroup service method.</param> <returns>The response from the UpdateGroup service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateGroupAsync(Amazon.IdentityManagement.Model.UpdateGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateLoginProfile(Amazon.IdentityManagement.Model.UpdateLoginProfileRequest)"> <summary> Changes the password for the specified user. <para> Users can change their own passwords by calling <a>ChangePassword</a>. For more information about modifying passwords, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing Passwords</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateLoginProfile service method.</param> <returns>The response from the UpdateLoginProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityTemporarilyUnmodifiableException"> The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.PasswordPolicyViolationException"> The request was rejected because the provided password did not meet the requirements imposed by the account password policy. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateLoginProfileAsync(Amazon.IdentityManagement.Model.UpdateLoginProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateLoginProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateLoginProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateOpenIDConnectProviderThumbprint(Amazon.IdentityManagement.Model.UpdateOpenIDConnectProviderThumbprintRequest)"> <summary> Replaces the existing list of server certificate thumbprints with a new list. <para> The list that you pass with this action completely replaces the existing list of thumbprints. (The lists are not merged.) </para> <para> Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate <i>does</i> change, any attempt to assume an IAM role that specifies the OIDC provider as a principal will fail until the certificate thumbprint is updated. </para> <note>Because trust for the OpenID Connect provider is ultimately derived from the provider's certificate and is validated by the thumbprint, it is a best practice to limit access to the <code>UpdateOpenIDConnectProviderThumbprint</code> action to highly-privileged users. </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateOpenIDConnectProviderThumbprint service method.</param> <returns>The response from the UpdateOpenIDConnectProviderThumbprint service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateOpenIDConnectProviderThumbprintAsync(Amazon.IdentityManagement.Model.UpdateOpenIDConnectProviderThumbprintRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateOpenIDConnectProviderThumbprint operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateOpenIDConnectProviderThumbprint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateSAMLProvider(Amazon.IdentityManagement.Model.UpdateSAMLProviderRequest)"> <summary> Updates the metadata document for an existing SAML provider. <note>This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateSAMLProvider service method.</param> <returns>The response from the UpdateSAMLProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateSAMLProviderAsync(Amazon.IdentityManagement.Model.UpdateSAMLProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateSAMLProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateSAMLProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateServerCertificate(Amazon.IdentityManagement.Model.UpdateServerCertificateRequest)"> <summary> Updates the name and/or the path of the specified server certificate. <para> For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with Server Certificates</a> in the <i>IAM User Guide</i>. </para> <important>You should understand the implications of changing a server certificate's path or name. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs_manage.html#RenamingServerCerts">Renaming a Server Certificate</a> in the <i>IAM User Guide</i>.</important> <note>To change a server certificate name the requester must have appropriate permissions on both the source object and the target object. For example, to change the name from ProductionCert to ProdCert, the entity making the request must have permission on ProductionCert and ProdCert, or must have permission on all (*). For more information about permissions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access Management</a> in the <i>IAM User Guide</i>. </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateServerCertificate service method.</param> <returns>The response from the UpdateServerCertificate service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateServerCertificateAsync(Amazon.IdentityManagement.Model.UpdateServerCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateServerCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServerCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateSigningCertificate(Amazon.IdentityManagement.Model.UpdateSigningCertificateRequest)"> <summary> Changes the status of the specified signing certificate from active to disabled, or vice versa. This action can be used to disable a user's signing certificate as part of a certificate rotation work flow. <para> If the <code>UserName</code> field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateSigningCertificate service method.</param> <returns>The response from the UpdateSigningCertificate service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateSigningCertificateAsync(Amazon.IdentityManagement.Model.UpdateSigningCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateSigningCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateSigningCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateSSHPublicKey(Amazon.IdentityManagement.Model.UpdateSSHPublicKeyRequest)"> <summary> Sets the status of the specified SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This action can be used to disable a user's SSH public key as part of a key rotation work flow. <para> The SSH public key affected by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateSSHPublicKey service method.</param> <returns>The response from the UpdateSSHPublicKey service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateSSHPublicKeyAsync(Amazon.IdentityManagement.Model.UpdateSSHPublicKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateSSHPublicKey operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateSSHPublicKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateUser(Amazon.IdentityManagement.Model.UpdateUserRequest)"> <summary> Updates the name and/or the path of the specified user. <important> You should understand the implications of changing a user's path or name. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html">Renaming Users and Groups</a> in the <i>IAM User Guide</i>. </important> <note> To change a user name the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html" target="blank">Permissions and Policies</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateUser service method.</param> <returns>The response from the UpdateUser service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.EntityTemporarilyUnmodifiableException"> The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UpdateUserAsync(Amazon.IdentityManagement.Model.UpdateUserRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateUser operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateUser operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UploadServerCertificate(Amazon.IdentityManagement.Model.UploadServerCertificateRequest)"> <summary> Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded. <para> For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with Server Certificates</a> in the <i>IAM User Guide</i>. </para> <para> For information about the number of server certificates you can upload, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html">Limitations on IAM Entities and Objects</a> in the <i>IAM User Guide</i>. </para> <note>Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling <code>UploadServerCertificate</code>. For information about setting up signatures and authorization through the API, go to <a href="http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information about using the Query API with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/programming.html">Calling the API by Making HTTP Query Requests</a> in the <i>IAM User Guide</i>. </note> </summary> <param name="request">Container for the necessary parameters to execute the UploadServerCertificate service method.</param> <returns>The response from the UploadServerCertificate service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.KeyPairMismatchException"> The request was rejected because the public key certificate and the private key do not match. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedCertificateException"> The request was rejected because the certificate was malformed or expired. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UploadServerCertificateAsync(Amazon.IdentityManagement.Model.UploadServerCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UploadServerCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the UploadServerCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UploadSigningCertificate(Amazon.IdentityManagement.Model.UploadSigningCertificateRequest)"> <summary> Uploads an X.509 signing certificate and associates it with the specified user. Some AWS services use X.509 signing certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is <code>Active</code>. <para> If the <code>UserName</code> field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> <note>Because the body of a X.509 certificate can be large, you should use POST rather than GET when calling <code>UploadSigningCertificate</code>. For information about setting up signatures and authorization through the API, go to <a href="http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information about using the Query API with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in the <i>Using IAM</i>guide. </note> </summary> <param name="request">Container for the necessary parameters to execute the UploadSigningCertificate service method.</param> <returns>The response from the UploadSigningCertificate service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DuplicateCertificateException"> The request was rejected because the same certificate is associated with an IAM user in the account. </exception> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidCertificateException"> The request was rejected because the certificate is invalid. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedCertificateException"> The request was rejected because the certificate was malformed or expired. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UploadSigningCertificateAsync(Amazon.IdentityManagement.Model.UploadSigningCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UploadSigningCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the UploadSigningCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UploadSSHPublicKey(Amazon.IdentityManagement.Model.UploadSSHPublicKeyRequest)"> <summary> Uploads an SSH public key and associates it with the specified IAM user. <para> The SSH public key uploaded by this action can be used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UploadSSHPublicKey service method.</param> <returns>The response from the UploadSSHPublicKey service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DuplicateSSHPublicKeyException"> The request was rejected because the SSH public key is already associated with the specified IAM user. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidPublicKeyException"> The request was rejected because the public key is malformed or otherwise invalid. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.UnrecognizedPublicKeyEncodingException"> The request was rejected because the public key encoding format is unsupported or unrecognized. </exception> </member> <member name="M:Amazon.IdentityManagement.IAmazonIdentityManagementService.UploadSSHPublicKeyAsync(Amazon.IdentityManagement.Model.UploadSSHPublicKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UploadSSHPublicKey operation. </summary> <param name="request">Container for the necessary parameters to execute the UploadSSHPublicKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.#ctor"> <summary> Constructs AmazonIdentityManagementServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonIdentityManagementServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.#ctor(Amazon.IdentityManagement.AmazonIdentityManagementServiceConfig)"> <summary> Constructs AmazonIdentityManagementServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonIdentityManagementServiceClient Configuration Object</param> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonIdentityManagementServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonIdentityManagementServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.IdentityManagement.AmazonIdentityManagementServiceConfig)"> <summary> Constructs AmazonIdentityManagementServiceClient with AWS Credentials and an AmazonIdentityManagementServiceClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonIdentityManagementServiceClient Configuration Object</param> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonIdentityManagementServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonIdentityManagementServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.#ctor(System.String,System.String,Amazon.IdentityManagement.AmazonIdentityManagementServiceConfig)"> <summary> Constructs AmazonIdentityManagementServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonIdentityManagementServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonIdentityManagementServiceClient Configuration Object</param> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonIdentityManagementServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonIdentityManagementServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.#ctor(System.String,System.String,System.String,Amazon.IdentityManagement.AmazonIdentityManagementServiceConfig)"> <summary> Constructs AmazonIdentityManagementServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonIdentityManagementServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonIdentityManagementServiceClient Configuration Object</param> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.AddClientIDToOpenIDConnectProvider(Amazon.IdentityManagement.Model.AddClientIDToOpenIDConnectProviderRequest)"> <summary> Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect provider. <para> This action is idempotent; it does not fail or return an error if you add an existing client ID to the provider. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddClientIDToOpenIDConnectProvider service method.</param> <returns>The response from the AddClientIDToOpenIDConnectProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.AddClientIDToOpenIDConnectProviderAsync(Amazon.IdentityManagement.Model.AddClientIDToOpenIDConnectProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddClientIDToOpenIDConnectProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the AddClientIDToOpenIDConnectProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.AddRoleToInstanceProfile(Amazon.IdentityManagement.Model.AddRoleToInstanceProfileRequest)"> <summary> Adds the specified role to the specified instance profile. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. </summary> <param name="request">Container for the necessary parameters to execute the AddRoleToInstanceProfile service method.</param> <returns>The response from the AddRoleToInstanceProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.AddRoleToInstanceProfileAsync(Amazon.IdentityManagement.Model.AddRoleToInstanceProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddRoleToInstanceProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the AddRoleToInstanceProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.AddUserToGroup(Amazon.IdentityManagement.Model.AddUserToGroupRequest)"> <summary> Adds the specified user to the specified group. </summary> <param name="request">Container for the necessary parameters to execute the AddUserToGroup service method.</param> <returns>The response from the AddUserToGroup service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.AddUserToGroupAsync(Amazon.IdentityManagement.Model.AddUserToGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddUserToGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the AddUserToGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.AttachGroupPolicy(Amazon.IdentityManagement.Model.AttachGroupPolicyRequest)"> <summary> Attaches the specified managed policy to the specified group. <para> You use this API to attach a managed policy to a group. To embed an inline policy in a group, use <a>PutGroupPolicy</a>. </para> <para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachGroupPolicy service method.</param> <returns>The response from the AttachGroupPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.AttachGroupPolicyAsync(Amazon.IdentityManagement.Model.AttachGroupPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachGroupPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachGroupPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.AttachRolePolicy(Amazon.IdentityManagement.Model.AttachRolePolicyRequest)"> <summary> Attaches the specified managed policy to the specified role. <para> When you attach a managed policy to a role, the managed policy is used as the role's access (permissions) policy. You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using <a>CreateRole</a>. You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>. </para> <para> Use this API to attach a managed policy to a role. To embed an inline policy in a role, use <a>PutRolePolicy</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachRolePolicy service method.</param> <returns>The response from the AttachRolePolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.AttachRolePolicyAsync(Amazon.IdentityManagement.Model.AttachRolePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachRolePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachRolePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.AttachUserPolicy(Amazon.IdentityManagement.Model.AttachUserPolicyRequest)"> <summary> Attaches the specified managed policy to the specified user. <para> You use this API to attach a managed policy to a user. To embed an inline policy in a user, use <a>PutUserPolicy</a>. </para> <para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachUserPolicy service method.</param> <returns>The response from the AttachUserPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.AttachUserPolicyAsync(Amazon.IdentityManagement.Model.AttachUserPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachUserPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachUserPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ChangePassword(Amazon.IdentityManagement.Model.ChangePasswordRequest)"> <summary> Changes the password of the IAM user who is calling this action. The root account password is not affected by this action. <para> To change the password for a different user, see <a>UpdateLoginProfile</a>. For more information about modifying passwords, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing Passwords</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ChangePassword service method.</param> <returns>The response from the ChangePassword service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityTemporarilyUnmodifiableException"> The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidUserTypeException"> The request was rejected because the type of user for the transaction was incorrect. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.PasswordPolicyViolationException"> The request was rejected because the provided password did not meet the requirements imposed by the account password policy. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ChangePasswordAsync(Amazon.IdentityManagement.Model.ChangePasswordRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ChangePassword operation. </summary> <param name="request">Container for the necessary parameters to execute the ChangePassword operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateAccessKey"> <summary> Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is <code>Active</code>. <para> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> <para> For information about limits on the number of keys you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> <important> To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys. </important> </summary> <returns>The response from the CreateAccessKey service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateAccessKey(Amazon.IdentityManagement.Model.CreateAccessKeyRequest)"> <summary> Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is <code>Active</code>. <para> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> <para> For information about limits on the number of keys you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> <important> To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys. </important> </summary> <param name="request">Container for the necessary parameters to execute the CreateAccessKey service method.</param> <returns>The response from the CreateAccessKey service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateAccessKeyAsync(Amazon.IdentityManagement.Model.CreateAccessKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAccessKey operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAccessKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateAccountAlias(Amazon.IdentityManagement.Model.CreateAccountAliasRequest)"> <summary> Creates an alias for your AWS account. For information about using an AWS account alias, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html">Using an Alias for Your AWS Account ID</a> in the <i>IAM User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the CreateAccountAlias service method.</param> <returns>The response from the CreateAccountAlias service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateAccountAliasAsync(Amazon.IdentityManagement.Model.CreateAccountAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAccountAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAccountAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateGroup(Amazon.IdentityManagement.Model.CreateGroupRequest)"> <summary> Creates a new group. <para> For information about the number of groups you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateGroup service method.</param> <returns>The response from the CreateGroup service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateGroupAsync(Amazon.IdentityManagement.Model.CreateGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateInstanceProfile(Amazon.IdentityManagement.Model.CreateInstanceProfileRequest)"> <summary> Creates a new instance profile. For information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. <para> For information about the number of instance profiles you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateInstanceProfile service method.</param> <returns>The response from the CreateInstanceProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateInstanceProfileAsync(Amazon.IdentityManagement.Model.CreateInstanceProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateInstanceProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInstanceProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateLoginProfile(Amazon.IdentityManagement.Model.CreateLoginProfileRequest)"> <summary> Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing Passwords</a> in the <i>Using IAM</i> guide. </summary> <param name="request">Container for the necessary parameters to execute the CreateLoginProfile service method.</param> <returns>The response from the CreateLoginProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.PasswordPolicyViolationException"> The request was rejected because the provided password did not meet the requirements imposed by the account password policy. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateLoginProfileAsync(Amazon.IdentityManagement.Model.CreateLoginProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLoginProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLoginProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateOpenIDConnectProvider(Amazon.IdentityManagement.Model.CreateOpenIDConnectProviderRequest)"> <summary> Creates an IAM entity to describe an identity provider (IdP) that supports <a href="http://openid.net/connect/">OpenID Connect (OIDC)</a>. <para> The OIDC provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and the OIDC provider. </para> <para> When you create the IAM OIDC provider, you specify the URL of the OIDC identity provider (IdP) to trust, a list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider, and a list of thumbprints of the server certificate(s) that the IdP uses. You get all of this information from the OIDC IdP that you want to use for access to AWS. </para> <note>Because trust for the OIDC provider is ultimately derived from the IAM provider that this action creates, it is a best practice to limit access to the <a>CreateOpenIDConnectProvider</a> action to highly-privileged users. </note> </summary> <param name="request">Container for the necessary parameters to execute the CreateOpenIDConnectProvider service method.</param> <returns>The response from the CreateOpenIDConnectProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateOpenIDConnectProviderAsync(Amazon.IdentityManagement.Model.CreateOpenIDConnectProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateOpenIDConnectProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateOpenIDConnectProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreatePolicy(Amazon.IdentityManagement.Model.CreatePolicyRequest)"> <summary> Creates a new managed policy for your AWS account. <para> This operation creates a policy version with a version identifier of <code>v1</code> and sets v1 as the policy's default version. For more information about policy versions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </para> <para> For more information about managed policies in general, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreatePolicy service method.</param> <returns>The response from the CreatePolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreatePolicyAsync(Amazon.IdentityManagement.Model.CreatePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreatePolicyVersion(Amazon.IdentityManagement.Model.CreatePolicyVersionRequest)"> <summary> Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using <a>DeletePolicyVersion</a> before you create a new version. <para> Optionally, you can set the new version as the policy's default version. The default version is the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to. </para> <para> For more information about managed policy versions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreatePolicyVersion service method.</param> <returns>The response from the CreatePolicyVersion service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreatePolicyVersionAsync(Amazon.IdentityManagement.Model.CreatePolicyVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePolicyVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePolicyVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateRole(Amazon.IdentityManagement.Model.CreateRoleRequest)"> <summary> Creates a new role for your AWS account. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. For information about limitations on role names and the number of roles you can create, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the CreateRole service method.</param> <returns>The response from the CreateRole service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateRoleAsync(Amazon.IdentityManagement.Model.CreateRoleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateRole operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateRole operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateSAMLProvider(Amazon.IdentityManagement.Model.CreateSAMLProviderRequest)"> <summary> Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0. <para> The SAML provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and a SAML identity provider. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS. </para> <para> When you create the SAML provider, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP. </para> <note> This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note> <para> For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html">Enabling SAML 2.0 Federated Users to Access the AWS Management Console</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About SAML 2.0-based Federation</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateSAMLProvider service method.</param> <returns>The response from the CreateSAMLProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateSAMLProviderAsync(Amazon.IdentityManagement.Model.CreateSAMLProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSAMLProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSAMLProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateUser(Amazon.IdentityManagement.Model.CreateUserRequest)"> <summary> Creates a new user for your AWS account. <para> For information about limitations on the number of users you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateUser service method.</param> <returns>The response from the CreateUser service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateUserAsync(Amazon.IdentityManagement.Model.CreateUserRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateUser operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateUser operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateVirtualMFADevice(Amazon.IdentityManagement.Model.CreateVirtualMFADeviceRequest)"> <summary> Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use <a>EnableMFADevice</a> to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Using a Virtual MFA Device</a> in the <i>Using IAM</i> guide. <para> For information about limits on the number of MFA devices you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on Entities</a> in the <i>Using IAM</i> guide. </para> <important>The seed information contained in the QR code and the Base32 string should be treated like any other secret access information, such as your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures. </important> </summary> <param name="request">Container for the necessary parameters to execute the CreateVirtualMFADevice service method.</param> <returns>The response from the CreateVirtualMFADevice service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateVirtualMFADeviceAsync(Amazon.IdentityManagement.Model.CreateVirtualMFADeviceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateVirtualMFADevice operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVirtualMFADevice operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeactivateMFADevice(Amazon.IdentityManagement.Model.DeactivateMFADeviceRequest)"> <summary> Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled. <para> For more information about creating and working with virtual MFA devices, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Using a Virtual MFA Device</a> in the <i>Using IAM</i> guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeactivateMFADevice service method.</param> <returns>The response from the DeactivateMFADevice service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityTemporarilyUnmodifiableException"> The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeactivateMFADeviceAsync(Amazon.IdentityManagement.Model.DeactivateMFADeviceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeactivateMFADevice operation. </summary> <param name="request">Container for the necessary parameters to execute the DeactivateMFADevice operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteAccessKey(Amazon.IdentityManagement.Model.DeleteAccessKeyRequest)"> <summary> Deletes the access key associated with the specified user. <para> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccessKey service method.</param> <returns>The response from the DeleteAccessKey service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteAccessKeyAsync(Amazon.IdentityManagement.Model.DeleteAccessKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAccessKey operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccessKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteAccountAlias(Amazon.IdentityManagement.Model.DeleteAccountAliasRequest)"> <summary> Deletes the specified AWS account alias. For information about using an AWS account alias, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html">Using an Alias for Your AWS Account ID</a> in the <i>IAM User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccountAlias service method.</param> <returns>The response from the DeleteAccountAlias service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteAccountAliasAsync(Amazon.IdentityManagement.Model.DeleteAccountAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAccountAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccountAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteAccountPasswordPolicy"> <summary> Deletes the password policy for the AWS account. </summary> <returns>The response from the DeleteAccountPasswordPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteAccountPasswordPolicy(Amazon.IdentityManagement.Model.DeleteAccountPasswordPolicyRequest)"> <summary> Deletes the password policy for the AWS account. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccountPasswordPolicy service method.</param> <returns>The response from the DeleteAccountPasswordPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteAccountPasswordPolicyAsync(Amazon.IdentityManagement.Model.DeleteAccountPasswordPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAccountPasswordPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccountPasswordPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteGroup(Amazon.IdentityManagement.Model.DeleteGroupRequest)"> <summary> Deletes the specified group. The group must not contain any users or have any attached policies. </summary> <param name="request">Container for the necessary parameters to execute the DeleteGroup service method.</param> <returns>The response from the DeleteGroup service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DeleteConflictException"> The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteGroupAsync(Amazon.IdentityManagement.Model.DeleteGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteGroupPolicy(Amazon.IdentityManagement.Model.DeleteGroupPolicyRequest)"> <summary> Deletes the specified inline policy that is embedded in the specified group. <para> A group can also have managed policies attached to it. To detach a managed policy from a group, use <a>DetachGroupPolicy</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteGroupPolicy service method.</param> <returns>The response from the DeleteGroupPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteGroupPolicyAsync(Amazon.IdentityManagement.Model.DeleteGroupPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteGroupPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteGroupPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteInstanceProfile(Amazon.IdentityManagement.Model.DeleteInstanceProfileRequest)"> <summary> Deletes the specified instance profile. The instance profile must not have an associated role. <important> Make sure you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance. </important> <para> For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteInstanceProfile service method.</param> <returns>The response from the DeleteInstanceProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DeleteConflictException"> The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteInstanceProfileAsync(Amazon.IdentityManagement.Model.DeleteInstanceProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteInstanceProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInstanceProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteLoginProfile(Amazon.IdentityManagement.Model.DeleteLoginProfileRequest)"> <summary> Deletes the password for the specified user, which terminates the user's ability to access AWS services through the AWS Management Console. <important> Deleting a user's password does not prevent a user from accessing IAM through the command line interface or the API. To prevent all user access you must also either make the access key inactive or delete it. For more information about making keys inactive or deleting them, see <a>UpdateAccessKey</a> and <a>DeleteAccessKey</a>. </important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoginProfile service method.</param> <returns>The response from the DeleteLoginProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityTemporarilyUnmodifiableException"> The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteLoginProfileAsync(Amazon.IdentityManagement.Model.DeleteLoginProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLoginProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoginProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteOpenIDConnectProvider(Amazon.IdentityManagement.Model.DeleteOpenIDConnectProviderRequest)"> <summary> Deletes an IAM OpenID Connect identity provider. <para> Deleting an OIDC provider does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a provider that has been deleted will fail. </para> <para> This action is idempotent; it does not fail or return an error if you call the action for a provider that was already deleted. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteOpenIDConnectProvider service method.</param> <returns>The response from the DeleteOpenIDConnectProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteOpenIDConnectProviderAsync(Amazon.IdentityManagement.Model.DeleteOpenIDConnectProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteOpenIDConnectProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteOpenIDConnectProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeletePolicy(Amazon.IdentityManagement.Model.DeletePolicyRequest)"> <summary> Deletes the specified managed policy. <para> Before you can delete a managed policy, you must detach the policy from all users, groups, and roles that it is attached to, and you must delete all of the policy's versions. The following steps describe the process for deleting a managed policy: <ol> <li>Detach the policy from all users, groups, and roles that the policy is attached to, using the <a>DetachUserPolicy</a>, <a>DetachGroupPolicy</a>, or <a>DetachRolePolicy</a> APIs. To list all the users, groups, and roles that a policy is attached to, use <a>ListEntitiesForPolicy</a>. </li> <li>Delete all versions of the policy using <a>DeletePolicyVersion</a>. To list the policy's versions, use <a>ListPolicyVersions</a>. You cannot use <a>DeletePolicyVersion</a> to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process. </li> <li>Delete the policy (this automatically deletes the policy's default version) using this API. </li> </ol> </para> <para> For information about managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeletePolicy service method.</param> <returns>The response from the DeletePolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DeleteConflictException"> The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeletePolicyAsync(Amazon.IdentityManagement.Model.DeletePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeletePolicyVersion(Amazon.IdentityManagement.Model.DeletePolicyVersionRequest)"> <summary> Deletes the specified version of the specified managed policy. <para> You cannot delete the default version of a policy using this API. To delete the default version of a policy, use <a>DeletePolicy</a>. To find out which version of a policy is marked as the default version, use <a>ListPolicyVersions</a>. </para> <para> For information about versions for managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeletePolicyVersion service method.</param> <returns>The response from the DeletePolicyVersion service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DeleteConflictException"> The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeletePolicyVersionAsync(Amazon.IdentityManagement.Model.DeletePolicyVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePolicyVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePolicyVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteRole(Amazon.IdentityManagement.Model.DeleteRoleRequest)"> <summary> Deletes the specified role. The role must not have any policies attached. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. <important>Make sure you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance. </important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteRole service method.</param> <returns>The response from the DeleteRole service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DeleteConflictException"> The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteRoleAsync(Amazon.IdentityManagement.Model.DeleteRoleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRole operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRole operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteRolePolicy(Amazon.IdentityManagement.Model.DeleteRolePolicyRequest)"> <summary> Deletes the specified inline policy that is embedded in the specified role. <para> A role can also have managed policies attached to it. To detach a managed policy from a role, use <a>DetachRolePolicy</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteRolePolicy service method.</param> <returns>The response from the DeleteRolePolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteRolePolicyAsync(Amazon.IdentityManagement.Model.DeleteRolePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRolePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRolePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteSAMLProvider(Amazon.IdentityManagement.Model.DeleteSAMLProviderRequest)"> <summary> Deletes a SAML provider. <para> Deleting the provider does not update any roles that reference the SAML provider as a principal in their trust policies. Any attempt to assume a role that references a SAML provider that has been deleted will fail. </para> <note> This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSAMLProvider service method.</param> <returns>The response from the DeleteSAMLProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteSAMLProviderAsync(Amazon.IdentityManagement.Model.DeleteSAMLProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSAMLProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSAMLProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteServerCertificate(Amazon.IdentityManagement.Model.DeleteServerCertificateRequest)"> <summary> Deletes the specified server certificate. <para> For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with Server Certificates</a> in the <i>IAM User Guide</i>. </para> <important> If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, go to <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_DeleteLoadBalancerListeners.html">DeleteLoadBalancerListeners</a> in the <i>Elastic Load Balancing API Reference</i>. </important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteServerCertificate service method.</param> <returns>The response from the DeleteServerCertificate service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DeleteConflictException"> The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteServerCertificateAsync(Amazon.IdentityManagement.Model.DeleteServerCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteServerCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteServerCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteSigningCertificate(Amazon.IdentityManagement.Model.DeleteSigningCertificateRequest)"> <summary> Deletes the specified signing certificate associated with the specified user. <para> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSigningCertificate service method.</param> <returns>The response from the DeleteSigningCertificate service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteSigningCertificateAsync(Amazon.IdentityManagement.Model.DeleteSigningCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSigningCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSigningCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteSSHPublicKey(Amazon.IdentityManagement.Model.DeleteSSHPublicKeyRequest)"> <summary> Deletes the specified SSH public key. <para> The SSH public key deleted by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSSHPublicKey service method.</param> <returns>The response from the DeleteSSHPublicKey service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteSSHPublicKeyAsync(Amazon.IdentityManagement.Model.DeleteSSHPublicKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSSHPublicKey operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSSHPublicKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteUser(Amazon.IdentityManagement.Model.DeleteUserRequest)"> <summary> Deletes the specified user. The user must not belong to any groups, have any keys or signing certificates, or have any attached policies. </summary> <param name="request">Container for the necessary parameters to execute the DeleteUser service method.</param> <returns>The response from the DeleteUser service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DeleteConflictException"> The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteUserAsync(Amazon.IdentityManagement.Model.DeleteUserRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteUser operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteUser operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteUserPolicy(Amazon.IdentityManagement.Model.DeleteUserPolicyRequest)"> <summary> Deletes the specified inline policy that is embedded in the specified user. <para> A user can also have managed policies attached to it. To detach a managed policy from a user, use <a>DetachUserPolicy</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteUserPolicy service method.</param> <returns>The response from the DeleteUserPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteUserPolicyAsync(Amazon.IdentityManagement.Model.DeleteUserPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteUserPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteUserPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteVirtualMFADevice(Amazon.IdentityManagement.Model.DeleteVirtualMFADeviceRequest)"> <summary> Deletes a virtual MFA device. <note> You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see <a>DeactivateMFADevice</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVirtualMFADevice service method.</param> <returns>The response from the DeleteVirtualMFADevice service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DeleteConflictException"> The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteVirtualMFADeviceAsync(Amazon.IdentityManagement.Model.DeleteVirtualMFADeviceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVirtualMFADevice operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVirtualMFADevice operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DetachGroupPolicy(Amazon.IdentityManagement.Model.DetachGroupPolicyRequest)"> <summary> Removes the specified managed policy from the specified group. <para> A group can also have inline policies embedded with it. To delete an inline policy, use the <a>DeleteGroupPolicy</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachGroupPolicy service method.</param> <returns>The response from the DetachGroupPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DetachGroupPolicyAsync(Amazon.IdentityManagement.Model.DetachGroupPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachGroupPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachGroupPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DetachRolePolicy(Amazon.IdentityManagement.Model.DetachRolePolicyRequest)"> <summary> Removes the specified managed policy from the specified role. <para> A role can also have inline policies embedded with it. To delete an inline policy, use the <a>DeleteRolePolicy</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachRolePolicy service method.</param> <returns>The response from the DetachRolePolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DetachRolePolicyAsync(Amazon.IdentityManagement.Model.DetachRolePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachRolePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachRolePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DetachUserPolicy(Amazon.IdentityManagement.Model.DetachUserPolicyRequest)"> <summary> Removes the specified managed policy from the specified user. <para> A user can also have inline policies embedded with it. To delete an inline policy, use the <a>DeleteUserPolicy</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachUserPolicy service method.</param> <returns>The response from the DetachUserPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DetachUserPolicyAsync(Amazon.IdentityManagement.Model.DetachUserPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachUserPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachUserPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EnableMFADevice(Amazon.IdentityManagement.Model.EnableMFADeviceRequest)"> <summary> Enables the specified MFA device and associates it with the specified user name. When enabled, the MFA device is required for every subsequent login by the user name associated with the device. </summary> <param name="request">Container for the necessary parameters to execute the EnableMFADevice service method.</param> <returns>The response from the EnableMFADevice service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.EntityTemporarilyUnmodifiableException"> The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidAuthenticationCodeException"> The request was rejected because the authentication code was not recognized. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EnableMFADeviceAsync(Amazon.IdentityManagement.Model.EnableMFADeviceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableMFADevice operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableMFADevice operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GenerateCredentialReport"> <summary> Generates a credential report for the AWS account. For more information about the credential report, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting Credential Reports</a> in the <i>IAM User Guide</i>. </summary> <returns>The response from the GenerateCredentialReport service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GenerateCredentialReport(Amazon.IdentityManagement.Model.GenerateCredentialReportRequest)"> <summary> Generates a credential report for the AWS account. For more information about the credential report, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting Credential Reports</a> in the <i>IAM User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the GenerateCredentialReport service method.</param> <returns>The response from the GenerateCredentialReport service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GenerateCredentialReportAsync(Amazon.IdentityManagement.Model.GenerateCredentialReportRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GenerateCredentialReport operation. </summary> <param name="request">Container for the necessary parameters to execute the GenerateCredentialReport operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetAccessKeyLastUsed(Amazon.IdentityManagement.Model.GetAccessKeyLastUsedRequest)"> <summary> Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the AWS service and region that were specified in the last request made with that key. </summary> <param name="request">Container for the necessary parameters to execute the GetAccessKeyLastUsed service method.</param> <returns>The response from the GetAccessKeyLastUsed service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetAccessKeyLastUsedAsync(Amazon.IdentityManagement.Model.GetAccessKeyLastUsedRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetAccessKeyLastUsed operation. </summary> <param name="request">Container for the necessary parameters to execute the GetAccessKeyLastUsed operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetAccountAuthorizationDetails(Amazon.IdentityManagement.Model.GetAccountAuthorizationDetailsRequest)"> <summary> Retrieves information about all IAM users, groups, roles, and policies in your account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account. <para> You can optionally filter the results using the <code>Filter</code> parameter. You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetAccountAuthorizationDetails service method.</param> <returns>The response from the GetAccountAuthorizationDetails service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetAccountAuthorizationDetailsAsync(Amazon.IdentityManagement.Model.GetAccountAuthorizationDetailsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetAccountAuthorizationDetails operation. </summary> <param name="request">Container for the necessary parameters to execute the GetAccountAuthorizationDetails operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetAccountPasswordPolicy"> <summary> Retrieves the password policy for the AWS account. For more information about using a password policy, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html">Managing an IAM Password Policy</a>. </summary> <returns>The response from the GetAccountPasswordPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetAccountPasswordPolicy(Amazon.IdentityManagement.Model.GetAccountPasswordPolicyRequest)"> <summary> Retrieves the password policy for the AWS account. For more information about using a password policy, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html">Managing an IAM Password Policy</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetAccountPasswordPolicy service method.</param> <returns>The response from the GetAccountPasswordPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetAccountPasswordPolicyAsync(Amazon.IdentityManagement.Model.GetAccountPasswordPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetAccountPasswordPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetAccountPasswordPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetAccountSummary"> <summary> Retrieves information about IAM entity usage and IAM quotas in the AWS account. <para> For information about limitations on IAM entities, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> </summary> <returns>The response from the GetAccountSummary service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetAccountSummary(Amazon.IdentityManagement.Model.GetAccountSummaryRequest)"> <summary> Retrieves information about IAM entity usage and IAM quotas in the AWS account. <para> For information about limitations on IAM entities, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetAccountSummary service method.</param> <returns>The response from the GetAccountSummary service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetAccountSummaryAsync(Amazon.IdentityManagement.Model.GetAccountSummaryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetAccountSummary operation. </summary> <param name="request">Container for the necessary parameters to execute the GetAccountSummary operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetContextKeysForCustomPolicy(System.Collections.Generic.List{System.String})"> <summary> Gets a list of all of the context keys referenced in <code>Condition</code> elements in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use <a>GetContextKeysForPrincipalPolicy</a>. <para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the <code>Condition</code> element of an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call <a>SimulateCustomPolicy</a>. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request. </para> </summary> <param name="policyInputList">A list of policies for which you want list of context keys used in <code>Condition</code> elements. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.</param> <returns>The response from the GetContextKeysForCustomPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetContextKeysForCustomPolicy(Amazon.IdentityManagement.Model.GetContextKeysForCustomPolicyRequest)"> <summary> Gets a list of all of the context keys referenced in <code>Condition</code> elements in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use <a>GetContextKeysForPrincipalPolicy</a>. <para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the <code>Condition</code> element of an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call <a>SimulateCustomPolicy</a>. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetContextKeysForCustomPolicy service method.</param> <returns>The response from the GetContextKeysForCustomPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetContextKeysForCustomPolicyAsync(Amazon.IdentityManagement.Model.GetContextKeysForCustomPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetContextKeysForCustomPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetContextKeysForCustomPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetContextKeysForPrincipalPolicy(System.String)"> <summary> Gets a list of all of the context keys referenced in <code>Condition</code> elements in all of the IAM policies attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of. <para> You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use <a>GetContextKeysForCustomPolicy</a> instead. </para> <para> <b>Note:</b> This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use <a>GetContextKeysForCustomPolicy</a> instead. </para> <para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the <code>Condition</code> element of an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call <a>SimulatePrincipalPolicy</a>. </para> </summary> <param name="policySourceArn">The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.</param> <returns>The response from the GetContextKeysForPrincipalPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetContextKeysForPrincipalPolicy(System.String,System.Collections.Generic.List{System.String})"> <summary> Gets a list of all of the context keys referenced in <code>Condition</code> elements in all of the IAM policies attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of. <para> You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use <a>GetContextKeysForCustomPolicy</a> instead. </para> <para> <b>Note:</b> This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use <a>GetContextKeysForCustomPolicy</a> instead. </para> <para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the <code>Condition</code> element of an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call <a>SimulatePrincipalPolicy</a>. </para> </summary> <param name="policySourceArn">The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.</param> <param name="policyInputList">A optional list of additional policies for which you want list of context keys used in <code>Condition</code> elements.</param> <returns>The response from the GetContextKeysForPrincipalPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetContextKeysForPrincipalPolicy(Amazon.IdentityManagement.Model.GetContextKeysForPrincipalPolicyRequest)"> <summary> Gets a list of all of the context keys referenced in <code>Condition</code> elements in all of the IAM policies attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of. <para> You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use <a>GetContextKeysForCustomPolicy</a> instead. </para> <para> <b>Note:</b> This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use <a>GetContextKeysForCustomPolicy</a> instead. </para> <para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the <code>Condition</code> element of an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call <a>SimulatePrincipalPolicy</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetContextKeysForPrincipalPolicy service method.</param> <returns>The response from the GetContextKeysForPrincipalPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetContextKeysForPrincipalPolicyAsync(Amazon.IdentityManagement.Model.GetContextKeysForPrincipalPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetContextKeysForPrincipalPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetContextKeysForPrincipalPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetCredentialReport"> <summary> Retrieves a credential report for the AWS account. For more information about the credential report, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting Credential Reports</a> in the <i>IAM User Guide</i>. </summary> <returns>The response from the GetCredentialReport service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.CredentialReportExpiredException"> The request was rejected because the most recent credential report has expired. To generate a new credential report, use <a>GenerateCredentialReport</a>. For more information about credential report expiration, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting Credential Reports</a> in the <i>IAM User Guide</i>. </exception> <exception cref="T:Amazon.IdentityManagement.Model.CredentialReportNotPresentException"> The request was rejected because the credential report does not exist. To generate a credential report, use <a>GenerateCredentialReport</a>. </exception> <exception cref="T:Amazon.IdentityManagement.Model.CredentialReportNotReadyException"> The request was rejected because the credential report is still being generated. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetCredentialReport(Amazon.IdentityManagement.Model.GetCredentialReportRequest)"> <summary> Retrieves a credential report for the AWS account. For more information about the credential report, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting Credential Reports</a> in the <i>IAM User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the GetCredentialReport service method.</param> <returns>The response from the GetCredentialReport service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.CredentialReportExpiredException"> The request was rejected because the most recent credential report has expired. To generate a new credential report, use <a>GenerateCredentialReport</a>. For more information about credential report expiration, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting Credential Reports</a> in the <i>IAM User Guide</i>. </exception> <exception cref="T:Amazon.IdentityManagement.Model.CredentialReportNotPresentException"> The request was rejected because the credential report does not exist. To generate a credential report, use <a>GenerateCredentialReport</a>. </exception> <exception cref="T:Amazon.IdentityManagement.Model.CredentialReportNotReadyException"> The request was rejected because the credential report is still being generated. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetCredentialReportAsync(Amazon.IdentityManagement.Model.GetCredentialReportRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetCredentialReport operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCredentialReport operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetGroup(Amazon.IdentityManagement.Model.GetGroupRequest)"> <summary> Returns a list of users that are in the specified group. You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </summary> <param name="request">Container for the necessary parameters to execute the GetGroup service method.</param> <returns>The response from the GetGroup service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetGroupAsync(Amazon.IdentityManagement.Model.GetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the GetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetGroupPolicy(Amazon.IdentityManagement.Model.GetGroupPolicyRequest)"> <summary> Retrieves the specified inline policy document that is embedded in the specified group. <para> A group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document. </para> <para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetGroupPolicy service method.</param> <returns>The response from the GetGroupPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetGroupPolicyAsync(Amazon.IdentityManagement.Model.GetGroupPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetGroupPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetGroupPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetInstanceProfile(Amazon.IdentityManagement.Model.GetInstanceProfileRequest)"> <summary> Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. For more information about ARNs, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_ARNs">ARNs</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetInstanceProfile service method.</param> <returns>The response from the GetInstanceProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetInstanceProfileAsync(Amazon.IdentityManagement.Model.GetInstanceProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetInstanceProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the GetInstanceProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetLoginProfile(Amazon.IdentityManagement.Model.GetLoginProfileRequest)"> <summary> Retrieves the user name and password-creation date for the specified user. If the user has not been assigned a password, the action returns a 404 (<code>NoSuchEntity</code>) error. </summary> <param name="request">Container for the necessary parameters to execute the GetLoginProfile service method.</param> <returns>The response from the GetLoginProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetLoginProfileAsync(Amazon.IdentityManagement.Model.GetLoginProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetLoginProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the GetLoginProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetOpenIDConnectProvider(Amazon.IdentityManagement.Model.GetOpenIDConnectProviderRequest)"> <summary> Returns information about the specified OpenID Connect provider. </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIDConnectProvider service method.</param> <returns>The response from the GetOpenIDConnectProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetOpenIDConnectProviderAsync(Amazon.IdentityManagement.Model.GetOpenIDConnectProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetOpenIDConnectProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIDConnectProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetPolicy(Amazon.IdentityManagement.Model.GetPolicyRequest)"> <summary> Retrieves information about the specified managed policy, including the policy's default version and the total number of users, groups, and roles that the policy is attached to. For a list of the specific users, groups, and roles that the policy is attached to, use the <a>ListEntitiesForPolicy</a> API. This API returns metadata about the policy. To retrieve the policy document for a specific version of the policy, use <a>GetPolicyVersion</a>. <para> This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with a user, group, or role, use the <a>GetUserPolicy</a>, <a>GetGroupPolicy</a>, or <a>GetRolePolicy</a> API. </para> <para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetPolicy service method.</param> <returns>The response from the GetPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetPolicyAsync(Amazon.IdentityManagement.Model.GetPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetPolicyVersion(Amazon.IdentityManagement.Model.GetPolicyVersionRequest)"> <summary> Retrieves information about the specified version of the specified managed policy, including the policy document. <para> To list the available versions for a policy, use <a>ListPolicyVersions</a>. </para> <para> This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use the <a>GetUserPolicy</a>, <a>GetGroupPolicy</a>, or <a>GetRolePolicy</a> API. </para> <para> For more information about the types of policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetPolicyVersion service method.</param> <returns>The response from the GetPolicyVersion service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetPolicyVersionAsync(Amazon.IdentityManagement.Model.GetPolicyVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetPolicyVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPolicyVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetRole(Amazon.IdentityManagement.Model.GetRoleRequest)"> <summary> Retrieves information about the specified role, including the role's path, GUID, ARN, and the policy granting permission to assume the role. For more information about ARNs, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_ARNs">ARNs</a>. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetRole service method.</param> <returns>The response from the GetRole service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetRoleAsync(Amazon.IdentityManagement.Model.GetRoleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetRole operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRole operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetRolePolicy(Amazon.IdentityManagement.Model.GetRolePolicyRequest)"> <summary> Retrieves the specified inline policy document that is embedded with the specified role. <para> A role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document. </para> <para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using Roles to Delegate Permissions and Federate Identities</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetRolePolicy service method.</param> <returns>The response from the GetRolePolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetRolePolicyAsync(Amazon.IdentityManagement.Model.GetRolePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetRolePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRolePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetSAMLProvider(Amazon.IdentityManagement.Model.GetSAMLProviderRequest)"> <summary> Returns the SAML provider metadocument that was uploaded when the provider was created or updated. <note>This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the GetSAMLProvider service method.</param> <returns>The response from the GetSAMLProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetSAMLProviderAsync(Amazon.IdentityManagement.Model.GetSAMLProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSAMLProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSAMLProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetServerCertificate(Amazon.IdentityManagement.Model.GetServerCertificateRequest)"> <summary> Retrieves information about the specified server certificate. <para> For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with Server Certificates</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetServerCertificate service method.</param> <returns>The response from the GetServerCertificate service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetServerCertificateAsync(Amazon.IdentityManagement.Model.GetServerCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetServerCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the GetServerCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetSSHPublicKey(Amazon.IdentityManagement.Model.GetSSHPublicKeyRequest)"> <summary> Retrieves the specified SSH public key, including metadata about the key. <para> The SSH public key retrieved by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetSSHPublicKey service method.</param> <returns>The response from the GetSSHPublicKey service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.UnrecognizedPublicKeyEncodingException"> The request was rejected because the public key encoding format is unsupported or unrecognized. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetSSHPublicKeyAsync(Amazon.IdentityManagement.Model.GetSSHPublicKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSSHPublicKey operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSSHPublicKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetUser"> <summary> Retrieves information about the specified user, including the user's creation date, path, unique ID, and ARN. <para> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request. </para> </summary> <returns>The response from the GetUser service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetUser(Amazon.IdentityManagement.Model.GetUserRequest)"> <summary> Retrieves information about the specified user, including the user's creation date, path, unique ID, and ARN. <para> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetUser service method.</param> <returns>The response from the GetUser service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetUserAsync(Amazon.IdentityManagement.Model.GetUserRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetUser operation. </summary> <param name="request">Container for the necessary parameters to execute the GetUser operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetUserPolicy(Amazon.IdentityManagement.Model.GetUserPolicyRequest)"> <summary> Retrieves the specified inline policy document that is embedded in the specified user. <para> A user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document. </para> <para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetUserPolicy service method.</param> <returns>The response from the GetUserPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetUserPolicyAsync(Amazon.IdentityManagement.Model.GetUserPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetUserPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetUserPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListAccessKeys"> <summary> Returns information about the access key IDs associated with the specified user. If there are none, the action returns an empty list. <para> Although each user is limited to a small number of keys, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> <para> If the <code>UserName</code> field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> <note>To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. </note> </summary> <returns>The response from the ListAccessKeys service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListAccessKeys(Amazon.IdentityManagement.Model.ListAccessKeysRequest)"> <summary> Returns information about the access key IDs associated with the specified user. If there are none, the action returns an empty list. <para> Although each user is limited to a small number of keys, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> <para> If the <code>UserName</code> field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> <note>To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. </note> </summary> <param name="request">Container for the necessary parameters to execute the ListAccessKeys service method.</param> <returns>The response from the ListAccessKeys service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListAccessKeysAsync(Amazon.IdentityManagement.Model.ListAccessKeysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAccessKeys operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAccessKeys operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListAccountAliases"> <summary> Lists the account alias associated with the account (Note: you can have only one). For information about using an AWS account alias, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html">Using an Alias for Your AWS Account ID</a> in the <i>IAM User Guide</i>. </summary> <returns>The response from the ListAccountAliases service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListAccountAliases(Amazon.IdentityManagement.Model.ListAccountAliasesRequest)"> <summary> Lists the account alias associated with the account (Note: you can have only one). For information about using an AWS account alias, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html">Using an Alias for Your AWS Account ID</a> in the <i>IAM User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ListAccountAliases service method.</param> <returns>The response from the ListAccountAliases service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListAccountAliasesAsync(Amazon.IdentityManagement.Model.ListAccountAliasesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAccountAliases operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAccountAliases operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListAttachedGroupPolicies(Amazon.IdentityManagement.Model.ListAttachedGroupPoliciesRequest)"> <summary> Lists all managed policies that are attached to the specified group. <para> A group can also have inline policies embedded with it. To list the inline policies for a group, use the <a>ListGroupPolicies</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. You can use the <code>PathPrefix</code> parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListAttachedGroupPolicies service method.</param> <returns>The response from the ListAttachedGroupPolicies service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListAttachedGroupPoliciesAsync(Amazon.IdentityManagement.Model.ListAttachedGroupPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAttachedGroupPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAttachedGroupPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListAttachedRolePolicies(Amazon.IdentityManagement.Model.ListAttachedRolePoliciesRequest)"> <summary> Lists all managed policies that are attached to the specified role. <para> A role can also have inline policies embedded with it. To list the inline policies for a role, use the <a>ListRolePolicies</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. You can use the <code>PathPrefix</code> parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the action returns an empty list. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListAttachedRolePolicies service method.</param> <returns>The response from the ListAttachedRolePolicies service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListAttachedRolePoliciesAsync(Amazon.IdentityManagement.Model.ListAttachedRolePoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAttachedRolePolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAttachedRolePolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListAttachedUserPolicies(Amazon.IdentityManagement.Model.ListAttachedUserPoliciesRequest)"> <summary> Lists all managed policies that are attached to the specified user. <para> A user can also have inline policies embedded with it. To list the inline policies for a user, use the <a>ListUserPolicies</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. You can use the <code>PathPrefix</code> parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListAttachedUserPolicies service method.</param> <returns>The response from the ListAttachedUserPolicies service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListAttachedUserPoliciesAsync(Amazon.IdentityManagement.Model.ListAttachedUserPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAttachedUserPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAttachedUserPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListEntitiesForPolicy(Amazon.IdentityManagement.Model.ListEntitiesForPolicyRequest)"> <summary> Lists all users, groups, and roles that the specified managed policy is attached to. <para> You can use the optional <code>EntityFilter</code> parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set <code>EntityFilter</code> to <code>Role</code>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListEntitiesForPolicy service method.</param> <returns>The response from the ListEntitiesForPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListEntitiesForPolicyAsync(Amazon.IdentityManagement.Model.ListEntitiesForPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListEntitiesForPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the ListEntitiesForPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListGroupPolicies(Amazon.IdentityManagement.Model.ListGroupPoliciesRequest)"> <summary> Lists the names of the inline policies that are embedded in the specified group. <para> A group can also have managed policies attached to it. To list the managed policies that are attached to a group, use <a>ListAttachedGroupPolicies</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified group, the action returns an empty list. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListGroupPolicies service method.</param> <returns>The response from the ListGroupPolicies service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListGroupPoliciesAsync(Amazon.IdentityManagement.Model.ListGroupPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListGroupPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListGroupPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListGroups"> <summary> Lists the groups that have the specified path prefix. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <returns>The response from the ListGroups service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListGroups(Amazon.IdentityManagement.Model.ListGroupsRequest)"> <summary> Lists the groups that have the specified path prefix. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListGroups service method.</param> <returns>The response from the ListGroups service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListGroupsAsync(Amazon.IdentityManagement.Model.ListGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the ListGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListGroupsForUser(Amazon.IdentityManagement.Model.ListGroupsForUserRequest)"> <summary> Lists the groups the specified user belongs to. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListGroupsForUser service method.</param> <returns>The response from the ListGroupsForUser service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListGroupsForUserAsync(Amazon.IdentityManagement.Model.ListGroupsForUserRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListGroupsForUser operation. </summary> <param name="request">Container for the necessary parameters to execute the ListGroupsForUser operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListInstanceProfiles"> <summary> Lists the instance profiles that have the specified path prefix. If there are none, the action returns an empty list. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <returns>The response from the ListInstanceProfiles service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListInstanceProfiles(Amazon.IdentityManagement.Model.ListInstanceProfilesRequest)"> <summary> Lists the instance profiles that have the specified path prefix. If there are none, the action returns an empty list. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceProfiles service method.</param> <returns>The response from the ListInstanceProfiles service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListInstanceProfilesAsync(Amazon.IdentityManagement.Model.ListInstanceProfilesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListInstanceProfiles operation. </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceProfiles operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListInstanceProfilesForRole(Amazon.IdentityManagement.Model.ListInstanceProfilesForRoleRequest)"> <summary> Lists the instance profiles that have the specified associated role. If there are none, the action returns an empty list. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceProfilesForRole service method.</param> <returns>The response from the ListInstanceProfilesForRole service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListInstanceProfilesForRoleAsync(Amazon.IdentityManagement.Model.ListInstanceProfilesForRoleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListInstanceProfilesForRole operation. </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceProfilesForRole operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListMFADevices"> <summary> Lists the MFA devices. If the request includes the user name, then this action lists all the MFA devices associated with the specified user name. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <returns>The response from the ListMFADevices service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListMFADevices(Amazon.IdentityManagement.Model.ListMFADevicesRequest)"> <summary> Lists the MFA devices. If the request includes the user name, then this action lists all the MFA devices associated with the specified user name. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListMFADevices service method.</param> <returns>The response from the ListMFADevices service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListMFADevicesAsync(Amazon.IdentityManagement.Model.ListMFADevicesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListMFADevices operation. </summary> <param name="request">Container for the necessary parameters to execute the ListMFADevices operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListOpenIDConnectProviders(Amazon.IdentityManagement.Model.ListOpenIDConnectProvidersRequest)"> <summary> Lists information about the OpenID Connect providers in the AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListOpenIDConnectProviders service method.</param> <returns>The response from the ListOpenIDConnectProviders service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListOpenIDConnectProvidersAsync(Amazon.IdentityManagement.Model.ListOpenIDConnectProvidersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListOpenIDConnectProviders operation. </summary> <param name="request">Container for the necessary parameters to execute the ListOpenIDConnectProviders operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListPolicies"> <summary> Lists all the managed policies that are available to your account, including your own customer managed policies and all AWS managed policies. <para> You can filter the list of policies that is returned using the optional <code>OnlyAttached</code>, <code>Scope</code>, and <code>PathPrefix</code> parameters. For example, to list only the customer managed policies in your AWS account, set <code>Scope</code> to <code>Local</code>. To list only AWS managed policies, set <code>Scope</code> to <code>AWS</code>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> <para> For more information about managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <returns>The response from the ListPolicies service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListPolicies(Amazon.IdentityManagement.Model.ListPoliciesRequest)"> <summary> Lists all the managed policies that are available to your account, including your own customer managed policies and all AWS managed policies. <para> You can filter the list of policies that is returned using the optional <code>OnlyAttached</code>, <code>Scope</code>, and <code>PathPrefix</code> parameters. For example, to list only the customer managed policies in your AWS account, set <code>Scope</code> to <code>Local</code>. To list only AWS managed policies, set <code>Scope</code> to <code>AWS</code>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> <para> For more information about managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListPolicies service method.</param> <returns>The response from the ListPolicies service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListPoliciesAsync(Amazon.IdentityManagement.Model.ListPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListPolicyVersions(Amazon.IdentityManagement.Model.ListPolicyVersionsRequest)"> <summary> Lists information about the versions of the specified managed policy, including the version that is set as the policy's default version. <para> For more information about managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListPolicyVersions service method.</param> <returns>The response from the ListPolicyVersions service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListPolicyVersionsAsync(Amazon.IdentityManagement.Model.ListPolicyVersionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListPolicyVersions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPolicyVersions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListRolePolicies(Amazon.IdentityManagement.Model.ListRolePoliciesRequest)"> <summary> Lists the names of the inline policies that are embedded in the specified role. <para> A role can also have managed policies attached to it. To list the managed policies that are attached to a role, use <a>ListAttachedRolePolicies</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified role, the action returns an empty list. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListRolePolicies service method.</param> <returns>The response from the ListRolePolicies service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListRolePoliciesAsync(Amazon.IdentityManagement.Model.ListRolePoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListRolePolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRolePolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListRoles"> <summary> Lists the roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <returns>The response from the ListRoles service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListRoles(Amazon.IdentityManagement.Model.ListRolesRequest)"> <summary> Lists the roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListRoles service method.</param> <returns>The response from the ListRoles service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListRolesAsync(Amazon.IdentityManagement.Model.ListRolesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListRoles operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRoles operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListSAMLProviders"> <summary> Lists the SAML providers in the account. <note> This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note> </summary> <returns>The response from the ListSAMLProviders service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListSAMLProviders(Amazon.IdentityManagement.Model.ListSAMLProvidersRequest)"> <summary> Lists the SAML providers in the account. <note> This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the ListSAMLProviders service method.</param> <returns>The response from the ListSAMLProviders service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListSAMLProvidersAsync(Amazon.IdentityManagement.Model.ListSAMLProvidersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListSAMLProviders operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSAMLProviders operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListServerCertificates"> <summary> Lists the server certificates that have the specified path prefix. If none exist, the action returns an empty list. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> <para> For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with Server Certificates</a> in the <i>IAM User Guide</i>. </para> </summary> <returns>The response from the ListServerCertificates service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListServerCertificates(Amazon.IdentityManagement.Model.ListServerCertificatesRequest)"> <summary> Lists the server certificates that have the specified path prefix. If none exist, the action returns an empty list. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> <para> For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with Server Certificates</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListServerCertificates service method.</param> <returns>The response from the ListServerCertificates service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListServerCertificatesAsync(Amazon.IdentityManagement.Model.ListServerCertificatesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListServerCertificates operation. </summary> <param name="request">Container for the necessary parameters to execute the ListServerCertificates operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListSigningCertificates"> <summary> Returns information about the signing certificates associated with the specified user. If there are none, the action returns an empty list. <para> Although each user is limited to a small number of signing certificates, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> <para> If the <code>UserName</code> field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> </summary> <returns>The response from the ListSigningCertificates service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListSigningCertificates(Amazon.IdentityManagement.Model.ListSigningCertificatesRequest)"> <summary> Returns information about the signing certificates associated with the specified user. If there are none, the action returns an empty list. <para> Although each user is limited to a small number of signing certificates, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> <para> If the <code>UserName</code> field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListSigningCertificates service method.</param> <returns>The response from the ListSigningCertificates service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListSigningCertificatesAsync(Amazon.IdentityManagement.Model.ListSigningCertificatesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListSigningCertificates operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSigningCertificates operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListSSHPublicKeys(Amazon.IdentityManagement.Model.ListSSHPublicKeysRequest)"> <summary> Returns information about the SSH public keys associated with the specified IAM user. If there are none, the action returns an empty list. <para> The SSH public keys returned by this action are used only for authenticating the IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>. </para> <para> Although each user is limited to a small number of keys, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListSSHPublicKeys service method.</param> <returns>The response from the ListSSHPublicKeys service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListSSHPublicKeysAsync(Amazon.IdentityManagement.Model.ListSSHPublicKeysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListSSHPublicKeys operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSSHPublicKeys operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListUserPolicies(Amazon.IdentityManagement.Model.ListUserPoliciesRequest)"> <summary> Lists the names of the inline policies embedded in the specified user. <para> A user can also have managed policies attached to it. To list the managed policies that are attached to a user, use <a>ListAttachedUserPolicies</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified user, the action returns an empty list. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListUserPolicies service method.</param> <returns>The response from the ListUserPolicies service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListUserPoliciesAsync(Amazon.IdentityManagement.Model.ListUserPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListUserPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListUserPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListUsers"> <summary> Lists the IAM users that have the specified path prefix. If no path prefix is specified, the action returns all users in the AWS account. If there are none, the action returns an empty list. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <returns>The response from the ListUsers service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListUsers(Amazon.IdentityManagement.Model.ListUsersRequest)"> <summary> Lists the IAM users that have the specified path prefix. If no path prefix is specified, the action returns all users in the AWS account. If there are none, the action returns an empty list. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListUsers service method.</param> <returns>The response from the ListUsers service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListUsersAsync(Amazon.IdentityManagement.Model.ListUsersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListUsers operation. </summary> <param name="request">Container for the necessary parameters to execute the ListUsers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListVirtualMFADevices"> <summary> Lists the virtual MFA devices under the AWS account by assignment status. If you do not specify an assignment status, the action returns a list of all virtual MFA devices. Assignment status can be <code>Assigned</code>, <code>Unassigned</code>, or <code>Any</code>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <returns>The response from the ListVirtualMFADevices service method, as returned by IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListVirtualMFADevices(Amazon.IdentityManagement.Model.ListVirtualMFADevicesRequest)"> <summary> Lists the virtual MFA devices under the AWS account by assignment status. If you do not specify an assignment status, the action returns a list of all virtual MFA devices. Assignment status can be <code>Assigned</code>, <code>Unassigned</code>, or <code>Any</code>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListVirtualMFADevices service method.</param> <returns>The response from the ListVirtualMFADevices service method, as returned by IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListVirtualMFADevicesAsync(Amazon.IdentityManagement.Model.ListVirtualMFADevicesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListVirtualMFADevices operation. </summary> <param name="request">Container for the necessary parameters to execute the ListVirtualMFADevices operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.PutGroupPolicy(Amazon.IdentityManagement.Model.PutGroupPolicyRequest)"> <summary> Adds (or updates) an inline policy document that is embedded in the specified group. <para> A user can also have managed policies attached to it. To attach a managed policy to a group, use <a>AttachGroupPolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> For information about limits on the number of inline policies that you can embed in a group, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutGroupPolicy</code>. For general information about using the Query API with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in the <i>Using IAM</i> guide. </note> </summary> <param name="request">Container for the necessary parameters to execute the PutGroupPolicy service method.</param> <returns>The response from the PutGroupPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.PutGroupPolicyAsync(Amazon.IdentityManagement.Model.PutGroupPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutGroupPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutGroupPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.PutRolePolicy(Amazon.IdentityManagement.Model.PutRolePolicyRequest)"> <summary> Adds (or updates) an inline policy document that is embedded in the specified role. <para> When you embed an inline policy in a role, the inline policy is used as the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using <a>CreateRole</a>. You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using Roles to Delegate Permissions and Federate Identities</a>. </para> <para> A role can also have a managed policy attached to it. To attach a managed policy to a role, use <a>AttachRolePolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> For information about limits on the number of inline policies that you can embed with a role, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutRolePolicy</code>. For general information about using the Query API with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in the <i>Using IAM</i> guide. </note> </summary> <param name="request">Container for the necessary parameters to execute the PutRolePolicy service method.</param> <returns>The response from the PutRolePolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.PutRolePolicyAsync(Amazon.IdentityManagement.Model.PutRolePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutRolePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutRolePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.PutUserPolicy(Amazon.IdentityManagement.Model.PutUserPolicyRequest)"> <summary> Adds (or updates) an inline policy document that is embedded in the specified user. <para> A user can also have a managed policy attached to it. To attach a managed policy to a user, use <a>AttachUserPolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> <para> For information about limits on the number of inline policies that you can embed in a user, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutUserPolicy</code>. For general information about using the Query API with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in the <i>Using IAM</i> guide. </note> </summary> <param name="request">Container for the necessary parameters to execute the PutUserPolicy service method.</param> <returns>The response from the PutUserPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.PutUserPolicyAsync(Amazon.IdentityManagement.Model.PutUserPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutUserPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutUserPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.RemoveClientIDFromOpenIDConnectProvider(Amazon.IdentityManagement.Model.RemoveClientIDFromOpenIDConnectProviderRequest)"> <summary> Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect provider. <para> This action is idempotent; it does not fail or return an error if you try to remove a client ID that was removed previously. </para> </summary> <param name="request">Container for the necessary parameters to execute the RemoveClientIDFromOpenIDConnectProvider service method.</param> <returns>The response from the RemoveClientIDFromOpenIDConnectProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.RemoveClientIDFromOpenIDConnectProviderAsync(Amazon.IdentityManagement.Model.RemoveClientIDFromOpenIDConnectProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveClientIDFromOpenIDConnectProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveClientIDFromOpenIDConnectProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.RemoveRoleFromInstanceProfile(Amazon.IdentityManagement.Model.RemoveRoleFromInstanceProfileRequest)"> <summary> Removes the specified role from the specified instance profile. <important> Make sure you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance will break any applications running on the instance. </important> <para> For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RemoveRoleFromInstanceProfile service method.</param> <returns>The response from the RemoveRoleFromInstanceProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.RemoveRoleFromInstanceProfileAsync(Amazon.IdentityManagement.Model.RemoveRoleFromInstanceProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveRoleFromInstanceProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveRoleFromInstanceProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.RemoveUserFromGroup(Amazon.IdentityManagement.Model.RemoveUserFromGroupRequest)"> <summary> Removes the specified user from the specified group. </summary> <param name="request">Container for the necessary parameters to execute the RemoveUserFromGroup service method.</param> <returns>The response from the RemoveUserFromGroup service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.RemoveUserFromGroupAsync(Amazon.IdentityManagement.Model.RemoveUserFromGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveUserFromGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveUserFromGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ResyncMFADevice(Amazon.IdentityManagement.Model.ResyncMFADeviceRequest)"> <summary> Synchronizes the specified MFA device with AWS servers. <para> For more information about creating and working with virtual MFA devices, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Using a Virtual MFA Device</a> in the <i>Using IAM</i> guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the ResyncMFADevice service method.</param> <returns>The response from the ResyncMFADevice service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidAuthenticationCodeException"> The request was rejected because the authentication code was not recognized. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ResyncMFADeviceAsync(Amazon.IdentityManagement.Model.ResyncMFADeviceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResyncMFADevice operation. </summary> <param name="request">Container for the necessary parameters to execute the ResyncMFADevice operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.SetDefaultPolicyVersion(Amazon.IdentityManagement.Model.SetDefaultPolicyVersionRequest)"> <summary> Sets the specified version of the specified policy as the policy's default (operative) version. <para> This action affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use the <a>ListEntitiesForPolicy</a> API. </para> <para> For information about managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetDefaultPolicyVersion service method.</param> <returns>The response from the SetDefaultPolicyVersion service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.SetDefaultPolicyVersionAsync(Amazon.IdentityManagement.Model.SetDefaultPolicyVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetDefaultPolicyVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the SetDefaultPolicyVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.SimulateCustomPolicy(Amazon.IdentityManagement.Model.SimulateCustomPolicyRequest)"> <summary> Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and AWS resources to determine the policies' effective permissions. The policies are provided as strings. <para> The simulation does not perform the API actions; it only checks the authorization to determine if the simulated policies allow or deny the actions. </para> <para> If you want to simulate existing policies attached to an IAM user, group, or role, use <a>SimulatePrincipalPolicy</a> instead. </para> <para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the <code>Condition</code> element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use <a>GetContextKeysForCustomPolicy</a>. </para> <para> If the output is long, you can use <code>MaxItems</code> and <code>Marker</code> parameters to paginate the results. </para> </summary> <param name="request">Container for the necessary parameters to execute the SimulateCustomPolicy service method.</param> <returns>The response from the SimulateCustomPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.PolicyEvaluationException"> The request failed because a provided policy could not be successfully evaluated. An additional detail message indicates the source of the failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.SimulateCustomPolicyAsync(Amazon.IdentityManagement.Model.SimulateCustomPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SimulateCustomPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the SimulateCustomPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.SimulatePrincipalPolicy(Amazon.IdentityManagement.Model.SimulatePrincipalPolicyRequest)"> <summary> Simulate how a set of IAM policies attached to an IAM entity works with a list of API actions and AWS resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to . <para> You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use <a>SimulateCustomPolicy</a> instead. </para> <para> You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation. </para> <para> The simulation does not perform the API actions, it only checks the authorization to determine if the simulated policies allow or deny the actions. </para> <para> <b>Note:</b> This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use <a>SimulateCustomPolicy</a> instead. </para> <para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the <code>Condition</code> element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use <a>GetContextKeysForPrincipalPolicy</a>. </para> <para> If the output is long, you can use the <code>MaxItems</code> and <code>Marker</code> parameters to paginate the results. </para> </summary> <param name="request">Container for the necessary parameters to execute the SimulatePrincipalPolicy service method.</param> <returns>The response from the SimulatePrincipalPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.PolicyEvaluationException"> The request failed because a provided policy could not be successfully evaluated. An additional detail message indicates the source of the failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.SimulatePrincipalPolicyAsync(Amazon.IdentityManagement.Model.SimulatePrincipalPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SimulatePrincipalPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the SimulatePrincipalPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateAccessKey(Amazon.IdentityManagement.Model.UpdateAccessKeyRequest)"> <summary> Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user's key as part of a key rotation work flow. <para> If the <code>UserName</code> field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> <para> For information about rotating keys, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html">Managing Keys and Certificates</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAccessKey service method.</param> <returns>The response from the UpdateAccessKey service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateAccessKeyAsync(Amazon.IdentityManagement.Model.UpdateAccessKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAccessKey operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAccessKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateAccountPasswordPolicy"> <summary> Updates the password policy settings for the AWS account. <note> <para> This action does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the <b>Request Parameters</b> section for each parameter's default value. </para> </note> <para> For more information about using a password policy, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html">Managing an IAM Password Policy</a> in the <i>IAM User Guide</i>. </para> </summary> <returns>The response from the UpdateAccountPasswordPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateAccountPasswordPolicy(Amazon.IdentityManagement.Model.UpdateAccountPasswordPolicyRequest)"> <summary> Updates the password policy settings for the AWS account. <note> <para> This action does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the <b>Request Parameters</b> section for each parameter's default value. </para> </note> <para> For more information about using a password policy, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html">Managing an IAM Password Policy</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAccountPasswordPolicy service method.</param> <returns>The response from the UpdateAccountPasswordPolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateAccountPasswordPolicyAsync(Amazon.IdentityManagement.Model.UpdateAccountPasswordPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAccountPasswordPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAccountPasswordPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateAssumeRolePolicy(Amazon.IdentityManagement.Model.UpdateAssumeRolePolicyRequest)"> <summary> Updates the policy that grants an entity permission to assume a role. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using Roles to Delegate Permissions and Federate Identities</a>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAssumeRolePolicy service method.</param> <returns>The response from the UpdateAssumeRolePolicy service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateAssumeRolePolicyAsync(Amazon.IdentityManagement.Model.UpdateAssumeRolePolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAssumeRolePolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAssumeRolePolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateGroup(Amazon.IdentityManagement.Model.UpdateGroupRequest)"> <summary> Updates the name and/or the path of the specified group. <important> You should understand the implications of changing a group's path or name. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html">Renaming Users and Groups</a> in the <i>IAM User Guide</i>. </important> <note>To change a group name the requester must have appropriate permissions on both the source object and the target object. For example, to change Managers to MGRs, the entity making the request must have permission on Managers and MGRs, or must have permission on all (*). For more information about permissions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html" target="blank">Permissions and Policies</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateGroup service method.</param> <returns>The response from the UpdateGroup service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateGroupAsync(Amazon.IdentityManagement.Model.UpdateGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateLoginProfile(Amazon.IdentityManagement.Model.UpdateLoginProfileRequest)"> <summary> Changes the password for the specified user. <para> Users can change their own passwords by calling <a>ChangePassword</a>. For more information about modifying passwords, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing Passwords</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateLoginProfile service method.</param> <returns>The response from the UpdateLoginProfile service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityTemporarilyUnmodifiableException"> The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.PasswordPolicyViolationException"> The request was rejected because the provided password did not meet the requirements imposed by the account password policy. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateLoginProfileAsync(Amazon.IdentityManagement.Model.UpdateLoginProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateLoginProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateLoginProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateOpenIDConnectProviderThumbprint(Amazon.IdentityManagement.Model.UpdateOpenIDConnectProviderThumbprintRequest)"> <summary> Replaces the existing list of server certificate thumbprints with a new list. <para> The list that you pass with this action completely replaces the existing list of thumbprints. (The lists are not merged.) </para> <para> Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate <i>does</i> change, any attempt to assume an IAM role that specifies the OIDC provider as a principal will fail until the certificate thumbprint is updated. </para> <note>Because trust for the OpenID Connect provider is ultimately derived from the provider's certificate and is validated by the thumbprint, it is a best practice to limit access to the <code>UpdateOpenIDConnectProviderThumbprint</code> action to highly-privileged users. </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateOpenIDConnectProviderThumbprint service method.</param> <returns>The response from the UpdateOpenIDConnectProviderThumbprint service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateOpenIDConnectProviderThumbprintAsync(Amazon.IdentityManagement.Model.UpdateOpenIDConnectProviderThumbprintRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateOpenIDConnectProviderThumbprint operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateOpenIDConnectProviderThumbprint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateSAMLProvider(Amazon.IdentityManagement.Model.UpdateSAMLProviderRequest)"> <summary> Updates the metadata document for an existing SAML provider. <note>This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateSAMLProvider service method.</param> <returns>The response from the UpdateSAMLProvider service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.InvalidInputException"> The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateSAMLProviderAsync(Amazon.IdentityManagement.Model.UpdateSAMLProviderRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateSAMLProvider operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateSAMLProvider operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateServerCertificate(Amazon.IdentityManagement.Model.UpdateServerCertificateRequest)"> <summary> Updates the name and/or the path of the specified server certificate. <para> For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with Server Certificates</a> in the <i>IAM User Guide</i>. </para> <important>You should understand the implications of changing a server certificate's path or name. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs_manage.html#RenamingServerCerts">Renaming a Server Certificate</a> in the <i>IAM User Guide</i>.</important> <note>To change a server certificate name the requester must have appropriate permissions on both the source object and the target object. For example, to change the name from ProductionCert to ProdCert, the entity making the request must have permission on ProductionCert and ProdCert, or must have permission on all (*). For more information about permissions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access Management</a> in the <i>IAM User Guide</i>. </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateServerCertificate service method.</param> <returns>The response from the UpdateServerCertificate service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateServerCertificateAsync(Amazon.IdentityManagement.Model.UpdateServerCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateServerCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServerCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateSigningCertificate(Amazon.IdentityManagement.Model.UpdateSigningCertificateRequest)"> <summary> Changes the status of the specified signing certificate from active to disabled, or vice versa. This action can be used to disable a user's signing certificate as part of a certificate rotation work flow. <para> If the <code>UserName</code> field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateSigningCertificate service method.</param> <returns>The response from the UpdateSigningCertificate service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateSigningCertificateAsync(Amazon.IdentityManagement.Model.UpdateSigningCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateSigningCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateSigningCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateSSHPublicKey(Amazon.IdentityManagement.Model.UpdateSSHPublicKeyRequest)"> <summary> Sets the status of the specified SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This action can be used to disable a user's SSH public key as part of a key rotation work flow. <para> The SSH public key affected by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateSSHPublicKey service method.</param> <returns>The response from the UpdateSSHPublicKey service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateSSHPublicKeyAsync(Amazon.IdentityManagement.Model.UpdateSSHPublicKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateSSHPublicKey operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateSSHPublicKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateUser(Amazon.IdentityManagement.Model.UpdateUserRequest)"> <summary> Updates the name and/or the path of the specified user. <important> You should understand the implications of changing a user's path or name. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html">Renaming Users and Groups</a> in the <i>IAM User Guide</i>. </important> <note> To change a user name the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html" target="blank">Permissions and Policies</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateUser service method.</param> <returns>The response from the UpdateUser service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.EntityTemporarilyUnmodifiableException"> The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateUserAsync(Amazon.IdentityManagement.Model.UpdateUserRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateUser operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateUser operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UploadServerCertificate(Amazon.IdentityManagement.Model.UploadServerCertificateRequest)"> <summary> Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded. <para> For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html">Working with Server Certificates</a> in the <i>IAM User Guide</i>. </para> <para> For information about the number of server certificates you can upload, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html">Limitations on IAM Entities and Objects</a> in the <i>IAM User Guide</i>. </para> <note>Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling <code>UploadServerCertificate</code>. For information about setting up signatures and authorization through the API, go to <a href="http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information about using the Query API with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/programming.html">Calling the API by Making HTTP Query Requests</a> in the <i>IAM User Guide</i>. </note> </summary> <param name="request">Container for the necessary parameters to execute the UploadServerCertificate service method.</param> <returns>The response from the UploadServerCertificate service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.KeyPairMismatchException"> The request was rejected because the public key certificate and the private key do not match. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedCertificateException"> The request was rejected because the certificate was malformed or expired. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UploadServerCertificateAsync(Amazon.IdentityManagement.Model.UploadServerCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UploadServerCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the UploadServerCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UploadSigningCertificate(Amazon.IdentityManagement.Model.UploadSigningCertificateRequest)"> <summary> Uploads an X.509 signing certificate and associates it with the specified user. Some AWS services use X.509 signing certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is <code>Active</code>. <para> If the <code>UserName</code> field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> <note>Because the body of a X.509 certificate can be large, you should use POST rather than GET when calling <code>UploadSigningCertificate</code>. For information about setting up signatures and authorization through the API, go to <a href="http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information about using the Query API with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in the <i>Using IAM</i>guide. </note> </summary> <param name="request">Container for the necessary parameters to execute the UploadSigningCertificate service method.</param> <returns>The response from the UploadSigningCertificate service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DuplicateCertificateException"> The request was rejected because the same certificate is associated with an IAM user in the account. </exception> <exception cref="T:Amazon.IdentityManagement.Model.EntityAlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidCertificateException"> The request was rejected because the certificate is invalid. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.MalformedCertificateException"> The request was rejected because the certificate was malformed or expired. The error message describes the specific error. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.ServiceFailureException"> The request processing has failed because of an unknown error, exception or failure. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UploadSigningCertificateAsync(Amazon.IdentityManagement.Model.UploadSigningCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UploadSigningCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the UploadSigningCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UploadSSHPublicKey(Amazon.IdentityManagement.Model.UploadSSHPublicKeyRequest)"> <summary> Uploads an SSH public key and associates it with the specified IAM user. <para> The SSH public key uploaded by this action can be used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UploadSSHPublicKey service method.</param> <returns>The response from the UploadSSHPublicKey service method, as returned by IdentityManagementService.</returns> <exception cref="T:Amazon.IdentityManagement.Model.DuplicateSSHPublicKeyException"> The request was rejected because the SSH public key is already associated with the specified IAM user. </exception> <exception cref="T:Amazon.IdentityManagement.Model.InvalidPublicKeyException"> The request was rejected because the public key is malformed or otherwise invalid. </exception> <exception cref="T:Amazon.IdentityManagement.Model.LimitExceededException"> The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded. </exception> <exception cref="T:Amazon.IdentityManagement.Model.NoSuchEntityException"> The request was rejected because it referenced an entity that does not exist. The error message describes the entity. </exception> <exception cref="T:Amazon.IdentityManagement.Model.UnrecognizedPublicKeyEncodingException"> The request was rejected because the public key encoding format is unsupported or unrecognized. </exception> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UploadSSHPublicKeyAsync(Amazon.IdentityManagement.Model.UploadSSHPublicKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UploadSSHPublicKey operation. </summary> <param name="request">Container for the necessary parameters to execute the UploadSSHPublicKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.ImportExport.AmazonImportExportClient"> <summary> Implementation for accessing ImportExport AWS Import/Export Service AWS Import/Export accelerates transferring large amounts of data between the AWS cloud and portable storage devices that you mail to us. AWS Import/Export transfers data directly onto and off of your storage devices using Amazon's high-speed internal network and bypassing the Internet. For large data sets, AWS Import/Export is often faster than Internet transfer and more cost effective than upgrading your connectivity. </summary> </member> <member name="T:Amazon.ImportExport.IAmazonImportExport"> <summary> Interface for accessing ImportExport AWS Import/Export Service AWS Import/Export accelerates transferring large amounts of data between the AWS cloud and portable storage devices that you mail to us. AWS Import/Export transfers data directly onto and off of your storage devices using Amazon's high-speed internal network and bypassing the Internet. For large data sets, AWS Import/Export is often faster than Internet transfer and more cost effective than upgrading your connectivity. </summary> </member> <member name="M:Amazon.ImportExport.IAmazonImportExport.CancelJob(Amazon.ImportExport.Model.CancelJobRequest)"> <summary> This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete. </summary> <param name="request">Container for the necessary parameters to execute the CancelJob service method.</param> <returns>The response from the CancelJob service method, as returned by ImportExport.</returns> <exception cref="T:Amazon.ImportExport.Model.CanceledJobIdException"> The specified job ID has been canceled and is no longer valid. </exception> <exception cref="T:Amazon.ImportExport.Model.ExpiredJobIdException"> Indicates that the specified job has expired out of the system. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidAccessKeyIdException"> The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidJobIdException"> The JOBID was missing, not found, or not associated with the AWS account. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidVersionException"> The client tool version is invalid. </exception> <exception cref="T:Amazon.ImportExport.Model.UnableToCancelJobIdException"> AWS Import/Export cannot cancel the job </exception> </member> <member name="M:Amazon.ImportExport.IAmazonImportExport.CancelJobAsync(Amazon.ImportExport.Model.CancelJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelJob operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ImportExport.IAmazonImportExport.CreateJob(Amazon.ImportExport.Model.CreateJobRequest)"> <summary> This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device. </summary> <param name="request">Container for the necessary parameters to execute the CreateJob service method.</param> <returns>The response from the CreateJob service method, as returned by ImportExport.</returns> <exception cref="T:Amazon.ImportExport.Model.BucketPermissionException"> The account specified does not have the appropriate bucket permissions. </exception> <exception cref="T:Amazon.ImportExport.Model.CreateJobQuotaExceededException"> Each account can create only a certain number of jobs per day. If you need to create more than this, please contact awsimportexport@amazon.com to explain your particular use case. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidAccessKeyIdException"> The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidAddressException"> The address specified in the manifest is invalid. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidCustomsException"> One or more customs parameters was invalid. Please correct and resubmit. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidFileSystemException"> File system specified in export manifest is invalid. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidJobIdException"> The JOBID was missing, not found, or not associated with the AWS account. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidManifestFieldException"> One or more manifest fields was invalid. Please correct and resubmit. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidParameterException"> One or more parameters had an invalid value. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidVersionException"> The client tool version is invalid. </exception> <exception cref="T:Amazon.ImportExport.Model.MalformedManifestException"> Your manifest is not well-formed. </exception> <exception cref="T:Amazon.ImportExport.Model.MissingCustomsException"> One or more required customs parameters was missing from the manifest. </exception> <exception cref="T:Amazon.ImportExport.Model.MissingManifestFieldException"> One or more required fields were missing from the manifest file. Please correct and resubmit. </exception> <exception cref="T:Amazon.ImportExport.Model.MissingParameterException"> One or more required parameters was missing from the request. </exception> <exception cref="T:Amazon.ImportExport.Model.MultipleRegionsException"> Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit. </exception> <exception cref="T:Amazon.ImportExport.Model.NoSuchBucketException"> The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to. </exception> </member> <member name="M:Amazon.ImportExport.IAmazonImportExport.CreateJobAsync(Amazon.ImportExport.Model.CreateJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateJob operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ImportExport.IAmazonImportExport.GetShippingLabel(Amazon.ImportExport.Model.GetShippingLabelRequest)"> <summary> This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own. </summary> <param name="request">Container for the necessary parameters to execute the GetShippingLabel service method.</param> <returns>The response from the GetShippingLabel service method, as returned by ImportExport.</returns> <exception cref="T:Amazon.ImportExport.Model.CanceledJobIdException"> The specified job ID has been canceled and is no longer valid. </exception> <exception cref="T:Amazon.ImportExport.Model.ExpiredJobIdException"> Indicates that the specified job has expired out of the system. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidAccessKeyIdException"> The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidAddressException"> The address specified in the manifest is invalid. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidJobIdException"> The JOBID was missing, not found, or not associated with the AWS account. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidParameterException"> One or more parameters had an invalid value. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidVersionException"> The client tool version is invalid. </exception> </member> <member name="M:Amazon.ImportExport.IAmazonImportExport.GetShippingLabelAsync(Amazon.ImportExport.Model.GetShippingLabelRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetShippingLabel operation. </summary> <param name="request">Container for the necessary parameters to execute the GetShippingLabel operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ImportExport.IAmazonImportExport.GetStatus(Amazon.ImportExport.Model.GetStatusRequest)"> <summary> This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own. </summary> <param name="request">Container for the necessary parameters to execute the GetStatus service method.</param> <returns>The response from the GetStatus service method, as returned by ImportExport.</returns> <exception cref="T:Amazon.ImportExport.Model.CanceledJobIdException"> The specified job ID has been canceled and is no longer valid. </exception> <exception cref="T:Amazon.ImportExport.Model.ExpiredJobIdException"> Indicates that the specified job has expired out of the system. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidAccessKeyIdException"> The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidJobIdException"> The JOBID was missing, not found, or not associated with the AWS account. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidVersionException"> The client tool version is invalid. </exception> </member> <member name="M:Amazon.ImportExport.IAmazonImportExport.GetStatusAsync(Amazon.ImportExport.Model.GetStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the GetStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ImportExport.IAmazonImportExport.ListJobs"> <summary> This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1. </summary> <returns>The response from the ListJobs service method, as returned by ImportExport.</returns> <exception cref="T:Amazon.ImportExport.Model.InvalidAccessKeyIdException"> The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidParameterException"> One or more parameters had an invalid value. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidVersionException"> The client tool version is invalid. </exception> </member> <member name="M:Amazon.ImportExport.IAmazonImportExport.ListJobs(Amazon.ImportExport.Model.ListJobsRequest)"> <summary> This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1. </summary> <param name="request">Container for the necessary parameters to execute the ListJobs service method.</param> <returns>The response from the ListJobs service method, as returned by ImportExport.</returns> <exception cref="T:Amazon.ImportExport.Model.InvalidAccessKeyIdException"> The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidParameterException"> One or more parameters had an invalid value. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidVersionException"> The client tool version is invalid. </exception> </member> <member name="M:Amazon.ImportExport.IAmazonImportExport.ListJobsAsync(Amazon.ImportExport.Model.ListJobsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListJobs operation. </summary> <param name="request">Container for the necessary parameters to execute the ListJobs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ImportExport.IAmazonImportExport.UpdateJob(Amazon.ImportExport.Model.UpdateJobRequest)"> <summary> You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own. </summary> <param name="request">Container for the necessary parameters to execute the UpdateJob service method.</param> <returns>The response from the UpdateJob service method, as returned by ImportExport.</returns> <exception cref="T:Amazon.ImportExport.Model.BucketPermissionException"> The account specified does not have the appropriate bucket permissions. </exception> <exception cref="T:Amazon.ImportExport.Model.CanceledJobIdException"> The specified job ID has been canceled and is no longer valid. </exception> <exception cref="T:Amazon.ImportExport.Model.ExpiredJobIdException"> Indicates that the specified job has expired out of the system. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidAccessKeyIdException"> The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidAddressException"> The address specified in the manifest is invalid. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidCustomsException"> One or more customs parameters was invalid. Please correct and resubmit. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidFileSystemException"> File system specified in export manifest is invalid. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidJobIdException"> The JOBID was missing, not found, or not associated with the AWS account. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidManifestFieldException"> One or more manifest fields was invalid. Please correct and resubmit. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidParameterException"> One or more parameters had an invalid value. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidVersionException"> The client tool version is invalid. </exception> <exception cref="T:Amazon.ImportExport.Model.MalformedManifestException"> Your manifest is not well-formed. </exception> <exception cref="T:Amazon.ImportExport.Model.MissingCustomsException"> One or more required customs parameters was missing from the manifest. </exception> <exception cref="T:Amazon.ImportExport.Model.MissingManifestFieldException"> One or more required fields were missing from the manifest file. Please correct and resubmit. </exception> <exception cref="T:Amazon.ImportExport.Model.MissingParameterException"> One or more required parameters was missing from the request. </exception> <exception cref="T:Amazon.ImportExport.Model.MultipleRegionsException"> Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit. </exception> <exception cref="T:Amazon.ImportExport.Model.NoSuchBucketException"> The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to. </exception> <exception cref="T:Amazon.ImportExport.Model.UnableToUpdateJobIdException"> AWS Import/Export cannot update the job </exception> </member> <member name="M:Amazon.ImportExport.IAmazonImportExport.UpdateJobAsync(Amazon.ImportExport.Model.UpdateJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateJob operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.#ctor"> <summary> Constructs AmazonImportExportClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonImportExportClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.#ctor(Amazon.ImportExport.AmazonImportExportConfig)"> <summary> Constructs AmazonImportExportClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonImportExportClient Configuration Object</param> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonImportExportClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonImportExportClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.ImportExport.AmazonImportExportConfig)"> <summary> Constructs AmazonImportExportClient with AWS Credentials and an AmazonImportExportClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonImportExportClient Configuration Object</param> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonImportExportClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonImportExportClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.#ctor(System.String,System.String,Amazon.ImportExport.AmazonImportExportConfig)"> <summary> Constructs AmazonImportExportClient with AWS Access Key ID, AWS Secret Key and an AmazonImportExportClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonImportExportClient Configuration Object</param> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonImportExportClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonImportExportClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.#ctor(System.String,System.String,System.String,Amazon.ImportExport.AmazonImportExportConfig)"> <summary> Constructs AmazonImportExportClient with AWS Access Key ID, AWS Secret Key and an AmazonImportExportClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonImportExportClient Configuration Object</param> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.CancelJob(Amazon.ImportExport.Model.CancelJobRequest)"> <summary> This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete. </summary> <param name="request">Container for the necessary parameters to execute the CancelJob service method.</param> <returns>The response from the CancelJob service method, as returned by ImportExport.</returns> <exception cref="T:Amazon.ImportExport.Model.CanceledJobIdException"> The specified job ID has been canceled and is no longer valid. </exception> <exception cref="T:Amazon.ImportExport.Model.ExpiredJobIdException"> Indicates that the specified job has expired out of the system. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidAccessKeyIdException"> The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidJobIdException"> The JOBID was missing, not found, or not associated with the AWS account. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidVersionException"> The client tool version is invalid. </exception> <exception cref="T:Amazon.ImportExport.Model.UnableToCancelJobIdException"> AWS Import/Export cannot cancel the job </exception> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.CancelJobAsync(Amazon.ImportExport.Model.CancelJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelJob operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.CreateJob(Amazon.ImportExport.Model.CreateJobRequest)"> <summary> This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device. </summary> <param name="request">Container for the necessary parameters to execute the CreateJob service method.</param> <returns>The response from the CreateJob service method, as returned by ImportExport.</returns> <exception cref="T:Amazon.ImportExport.Model.BucketPermissionException"> The account specified does not have the appropriate bucket permissions. </exception> <exception cref="T:Amazon.ImportExport.Model.CreateJobQuotaExceededException"> Each account can create only a certain number of jobs per day. If you need to create more than this, please contact awsimportexport@amazon.com to explain your particular use case. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidAccessKeyIdException"> The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidAddressException"> The address specified in the manifest is invalid. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidCustomsException"> One or more customs parameters was invalid. Please correct and resubmit. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidFileSystemException"> File system specified in export manifest is invalid. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidJobIdException"> The JOBID was missing, not found, or not associated with the AWS account. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidManifestFieldException"> One or more manifest fields was invalid. Please correct and resubmit. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidParameterException"> One or more parameters had an invalid value. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidVersionException"> The client tool version is invalid. </exception> <exception cref="T:Amazon.ImportExport.Model.MalformedManifestException"> Your manifest is not well-formed. </exception> <exception cref="T:Amazon.ImportExport.Model.MissingCustomsException"> One or more required customs parameters was missing from the manifest. </exception> <exception cref="T:Amazon.ImportExport.Model.MissingManifestFieldException"> One or more required fields were missing from the manifest file. Please correct and resubmit. </exception> <exception cref="T:Amazon.ImportExport.Model.MissingParameterException"> One or more required parameters was missing from the request. </exception> <exception cref="T:Amazon.ImportExport.Model.MultipleRegionsException"> Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit. </exception> <exception cref="T:Amazon.ImportExport.Model.NoSuchBucketException"> The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to. </exception> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.CreateJobAsync(Amazon.ImportExport.Model.CreateJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateJob operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.GetShippingLabel(Amazon.ImportExport.Model.GetShippingLabelRequest)"> <summary> This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own. </summary> <param name="request">Container for the necessary parameters to execute the GetShippingLabel service method.</param> <returns>The response from the GetShippingLabel service method, as returned by ImportExport.</returns> <exception cref="T:Amazon.ImportExport.Model.CanceledJobIdException"> The specified job ID has been canceled and is no longer valid. </exception> <exception cref="T:Amazon.ImportExport.Model.ExpiredJobIdException"> Indicates that the specified job has expired out of the system. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidAccessKeyIdException"> The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidAddressException"> The address specified in the manifest is invalid. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidJobIdException"> The JOBID was missing, not found, or not associated with the AWS account. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidParameterException"> One or more parameters had an invalid value. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidVersionException"> The client tool version is invalid. </exception> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.GetShippingLabelAsync(Amazon.ImportExport.Model.GetShippingLabelRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetShippingLabel operation. </summary> <param name="request">Container for the necessary parameters to execute the GetShippingLabel operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.GetStatus(Amazon.ImportExport.Model.GetStatusRequest)"> <summary> This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own. </summary> <param name="request">Container for the necessary parameters to execute the GetStatus service method.</param> <returns>The response from the GetStatus service method, as returned by ImportExport.</returns> <exception cref="T:Amazon.ImportExport.Model.CanceledJobIdException"> The specified job ID has been canceled and is no longer valid. </exception> <exception cref="T:Amazon.ImportExport.Model.ExpiredJobIdException"> Indicates that the specified job has expired out of the system. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidAccessKeyIdException"> The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidJobIdException"> The JOBID was missing, not found, or not associated with the AWS account. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidVersionException"> The client tool version is invalid. </exception> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.GetStatusAsync(Amazon.ImportExport.Model.GetStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the GetStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.ListJobs"> <summary> This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1. </summary> <returns>The response from the ListJobs service method, as returned by ImportExport.</returns> <exception cref="T:Amazon.ImportExport.Model.InvalidAccessKeyIdException"> The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidParameterException"> One or more parameters had an invalid value. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidVersionException"> The client tool version is invalid. </exception> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.ListJobs(Amazon.ImportExport.Model.ListJobsRequest)"> <summary> This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1. </summary> <param name="request">Container for the necessary parameters to execute the ListJobs service method.</param> <returns>The response from the ListJobs service method, as returned by ImportExport.</returns> <exception cref="T:Amazon.ImportExport.Model.InvalidAccessKeyIdException"> The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidParameterException"> One or more parameters had an invalid value. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidVersionException"> The client tool version is invalid. </exception> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.ListJobsAsync(Amazon.ImportExport.Model.ListJobsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListJobs operation. </summary> <param name="request">Container for the necessary parameters to execute the ListJobs operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.UpdateJob(Amazon.ImportExport.Model.UpdateJobRequest)"> <summary> You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own. </summary> <param name="request">Container for the necessary parameters to execute the UpdateJob service method.</param> <returns>The response from the UpdateJob service method, as returned by ImportExport.</returns> <exception cref="T:Amazon.ImportExport.Model.BucketPermissionException"> The account specified does not have the appropriate bucket permissions. </exception> <exception cref="T:Amazon.ImportExport.Model.CanceledJobIdException"> The specified job ID has been canceled and is no longer valid. </exception> <exception cref="T:Amazon.ImportExport.Model.ExpiredJobIdException"> Indicates that the specified job has expired out of the system. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidAccessKeyIdException"> The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidAddressException"> The address specified in the manifest is invalid. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidCustomsException"> One or more customs parameters was invalid. Please correct and resubmit. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidFileSystemException"> File system specified in export manifest is invalid. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidJobIdException"> The JOBID was missing, not found, or not associated with the AWS account. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidManifestFieldException"> One or more manifest fields was invalid. Please correct and resubmit. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidParameterException"> One or more parameters had an invalid value. </exception> <exception cref="T:Amazon.ImportExport.Model.InvalidVersionException"> The client tool version is invalid. </exception> <exception cref="T:Amazon.ImportExport.Model.MalformedManifestException"> Your manifest is not well-formed. </exception> <exception cref="T:Amazon.ImportExport.Model.MissingCustomsException"> One or more required customs parameters was missing from the manifest. </exception> <exception cref="T:Amazon.ImportExport.Model.MissingManifestFieldException"> One or more required fields were missing from the manifest file. Please correct and resubmit. </exception> <exception cref="T:Amazon.ImportExport.Model.MissingParameterException"> One or more required parameters was missing from the request. </exception> <exception cref="T:Amazon.ImportExport.Model.MultipleRegionsException"> Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit. </exception> <exception cref="T:Amazon.ImportExport.Model.NoSuchBucketException"> The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to. </exception> <exception cref="T:Amazon.ImportExport.Model.UnableToUpdateJobIdException"> AWS Import/Export cannot update the job </exception> </member> <member name="M:Amazon.ImportExport.AmazonImportExportClient.UpdateJobAsync(Amazon.ImportExport.Model.UpdateJobRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateJob operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateJob operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.KeyManagementService.AmazonKeyManagementServiceClient"> <summary> Implementation for accessing KeyManagementService AWS Key Management Service <para> AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the <a href="http://docs.aws.amazon.com/kms/latest/developerguide/">AWS Key Management Service Developer Guide</a>. </para> <note> <para> AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>. </para> </note> <para> We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS. </para> <para> Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes. </para> <para> <b>Signing Requests</b> </para> <para> Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you <i>do not</i> use your AWS account access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests. </para> <para> All AWS KMS operations require <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </para> <para> <b>Logging API Requests</b> </para> <para> AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/">AWS CloudTrail User Guide</a>. </para> <para> <b>Additional Resources</b> </para> <para> For more information about credentials and request signing, see the following: </para> <ul> <li> <a href="http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">AWS Security Credentials</a> - This topic provides general information about the types of credentials used for accessing AWS. </li> <li> <a href="http://docs.aws.amazon.com/STS/latest/UsingSTS/">AWS Security Token Service</a> - This guide describes how to create and use temporary security credentials. </li> <li> <a href="http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing AWS API Requests</a> - This set of topics walks you through the process of signing a request using an access key ID and a secret access key. </li> </ul> <para> <b>Commonly Used APIs</b> </para> <para> Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console. </para> <ul> <li><a>Encrypt</a></li> <li><a>Decrypt</a></li> <li><a>GenerateDataKey</a></li> <li><a>GenerateDataKeyWithoutPlaintext</a></li> </ul> </summary> </member> <member name="T:Amazon.KeyManagementService.IAmazonKeyManagementService"> <summary> Interface for accessing KeyManagementService AWS Key Management Service <para> AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the <a href="http://docs.aws.amazon.com/kms/latest/developerguide/">AWS Key Management Service Developer Guide</a>. </para> <note> <para> AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>. </para> </note> <para> We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS. </para> <para> Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes. </para> <para> <b>Signing Requests</b> </para> <para> Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you <i>do not</i> use your AWS account access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests. </para> <para> All AWS KMS operations require <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </para> <para> <b>Logging API Requests</b> </para> <para> AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/">AWS CloudTrail User Guide</a>. </para> <para> <b>Additional Resources</b> </para> <para> For more information about credentials and request signing, see the following: </para> <ul> <li> <a href="http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">AWS Security Credentials</a> - This topic provides general information about the types of credentials used for accessing AWS. </li> <li> <a href="http://docs.aws.amazon.com/STS/latest/UsingSTS/">AWS Security Token Service</a> - This guide describes how to create and use temporary security credentials. </li> <li> <a href="http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing AWS API Requests</a> - This set of topics walks you through the process of signing a request using an access key ID and a secret access key. </li> </ul> <para> <b>Commonly Used APIs</b> </para> <para> Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console. </para> <ul> <li><a>Encrypt</a></li> <li><a>Decrypt</a></li> <li><a>GenerateDataKey</a></li> <li><a>GenerateDataKeyWithoutPlaintext</a></li> </ul> </summary> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.CancelKeyDeletion(System.String)"> <summary> Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the <code>Disabled</code> state. To enable a CMK, use <a>EnableKey</a>. <para> For more information about scheduling and canceling deletion of a CMK, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </summary> <param name="keyId">The unique identifier for the customer master key (CMK) for which to cancel deletion. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: <ul> <li>Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab</li> <li>Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</li> </ul> To obtain the unique key ID and key ARN for a given CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</param> <returns>The response from the CancelKeyDeletion service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.CancelKeyDeletion(Amazon.KeyManagementService.Model.CancelKeyDeletionRequest)"> <summary> Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the <code>Disabled</code> state. To enable a CMK, use <a>EnableKey</a>. <para> For more information about scheduling and canceling deletion of a CMK, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CancelKeyDeletion service method.</param> <returns>The response from the CancelKeyDeletion service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.CancelKeyDeletionAsync(Amazon.KeyManagementService.Model.CancelKeyDeletionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelKeyDeletion operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelKeyDeletion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.CreateAlias(System.String,System.String)"> <summary> Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). <para> The alias and the key it is mapped to must be in the same AWS account and the same region. </para> <para> To map an alias to a different key, call <a>UpdateAlias</a>. </para> </summary> <param name="aliasName">String that contains the display name. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved. </param> <param name="targetKeyId">An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <returns>The response from the CreateAlias service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.AlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidAliasNameException"> The request was rejected because the specified alias name is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.LimitExceededException"> The request was rejected because a limit was exceeded. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.CreateAlias(Amazon.KeyManagementService.Model.CreateAliasRequest)"> <summary> Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). <para> The alias and the key it is mapped to must be in the same AWS account and the same region. </para> <para> To map an alias to a different key, call <a>UpdateAlias</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateAlias service method.</param> <returns>The response from the CreateAlias service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.AlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidAliasNameException"> The request was rejected because the specified alias name is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.LimitExceededException"> The request was rejected because a limit was exceeded. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.CreateAliasAsync(Amazon.KeyManagementService.Model.CreateAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.CreateGrant(Amazon.KeyManagementService.Model.CreateGrantRequest)"> <summary> Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies. <para> For more information about grants, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Grants</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateGrant service method.</param> <returns>The response from the CreateGrant service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantTokenException"> The request was rejected because a grant token provided as part of the request is invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.LimitExceededException"> The request was rejected because a limit was exceeded. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.CreateGrantAsync(Amazon.KeyManagementService.Model.CreateGrantRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateGrant operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateGrant operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.CreateKey(Amazon.KeyManagementService.Model.CreateKeyRequest)"> <summary> Creates a customer master key. Customer master keys can be used to encrypt small amounts of data (less than 4K) directly, but they are most commonly used to encrypt or envelope data keys that are then used to encrypt customer data. For more information about data keys, see <a>GenerateDataKey</a> and <a>GenerateDataKeyWithoutPlaintext</a>. </summary> <param name="request">Container for the necessary parameters to execute the CreateKey service method.</param> <returns>The response from the CreateKey service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.LimitExceededException"> The request was rejected because a limit was exceeded. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>. </exception> <exception cref="T:Amazon.KeyManagementService.Model.MalformedPolicyDocumentException"> The request was rejected because the specified policy is not syntactically or semantically correct. </exception> <exception cref="T:Amazon.KeyManagementService.Model.UnsupportedOperationException"> The request was rejected because a specified parameter is not supported. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.CreateKeyAsync(Amazon.KeyManagementService.Model.CreateKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateKey operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.Decrypt(Amazon.KeyManagementService.Model.DecryptRequest)"> <summary> Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions: <ul> <li><a>GenerateDataKey</a></li> <li><a>GenerateDataKeyWithoutPlaintext</a></li> <li><a>Encrypt</a></li> </ul> <para> Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant <code>Decrypt</code> permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant <code>Decrypt</code> access in an IAM user policy. Instead grant <code>Decrypt</code> access only in key policies. If you must grant <code>Decrypt</code> access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts. </para> </summary> <param name="request">Container for the necessary parameters to execute the Decrypt service method.</param> <returns>The response from the Decrypt service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidCiphertextException"> The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantTokenException"> The request was rejected because a grant token provided as part of the request is invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KeyUnavailableException"> The request was rejected because the key was not available. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.DecryptAsync(Amazon.KeyManagementService.Model.DecryptRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Decrypt operation. </summary> <param name="request">Container for the necessary parameters to execute the Decrypt operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.DeleteAlias(System.String)"> <summary> Deletes the specified alias. To map an alias to a different key, call <a>UpdateAlias</a>. </summary> <param name="aliasName">The alias to be deleted. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.</param> <returns>The response from the DeleteAlias service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.DeleteAlias(Amazon.KeyManagementService.Model.DeleteAliasRequest)"> <summary> Deletes the specified alias. To map an alias to a different key, call <a>UpdateAlias</a>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAlias service method.</param> <returns>The response from the DeleteAlias service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.DeleteAliasAsync(Amazon.KeyManagementService.Model.DeleteAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.DescribeKey(System.String)"> <summary> Provides detailed information about the specified customer master key. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/". <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> <li>Alias Name Example - alias/MyAliasName</li> </ul> </param> <returns>The response from the DescribeKey service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.DescribeKey(Amazon.KeyManagementService.Model.DescribeKeyRequest)"> <summary> Provides detailed information about the specified customer master key. </summary> <param name="request">Container for the necessary parameters to execute the DescribeKey service method.</param> <returns>The response from the DescribeKey service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.DescribeKeyAsync(Amazon.KeyManagementService.Model.DescribeKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeKey operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.DisableKey(System.String)"> <summary> Sets the state of a master key to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a master key, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <returns>The response from the DisableKey service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.DisableKey(Amazon.KeyManagementService.Model.DisableKeyRequest)"> <summary> Sets the state of a master key to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a master key, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DisableKey service method.</param> <returns>The response from the DisableKey service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.DisableKeyAsync(Amazon.KeyManagementService.Model.DisableKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableKey operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.DisableKeyRotation(System.String)"> <summary> Disables rotation of the specified key. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <returns>The response from the DisableKeyRotation service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.DisableKeyRotation(Amazon.KeyManagementService.Model.DisableKeyRotationRequest)"> <summary> Disables rotation of the specified key. </summary> <param name="request">Container for the necessary parameters to execute the DisableKeyRotation service method.</param> <returns>The response from the DisableKeyRotation service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.DisableKeyRotationAsync(Amazon.KeyManagementService.Model.DisableKeyRotationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableKeyRotation operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableKeyRotation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.EnableKey(System.String)"> <summary> Marks a key as enabled, thereby permitting its use. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <returns>The response from the EnableKey service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.LimitExceededException"> The request was rejected because a limit was exceeded. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.EnableKey(Amazon.KeyManagementService.Model.EnableKeyRequest)"> <summary> Marks a key as enabled, thereby permitting its use. </summary> <param name="request">Container for the necessary parameters to execute the EnableKey service method.</param> <returns>The response from the EnableKey service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.LimitExceededException"> The request was rejected because a limit was exceeded. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.EnableKeyAsync(Amazon.KeyManagementService.Model.EnableKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableKey operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.EnableKeyRotation(System.String)"> <summary> Enables rotation of the specified customer master key. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <returns>The response from the EnableKeyRotation service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.EnableKeyRotation(Amazon.KeyManagementService.Model.EnableKeyRotationRequest)"> <summary> Enables rotation of the specified customer master key. </summary> <param name="request">Container for the necessary parameters to execute the EnableKeyRotation service method.</param> <returns>The response from the EnableKeyRotation service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.EnableKeyRotationAsync(Amazon.KeyManagementService.Model.EnableKeyRotationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableKeyRotation operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableKeyRotation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.Encrypt(Amazon.KeyManagementService.Model.EncryptRequest)"> <summary> Encrypts plaintext into ciphertext by using a customer master key. The <code>Encrypt</code> function has two primary use cases: <ul> <li>You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.</li> <li>If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data. </li> </ul> <para> Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the <a>GenerateDataKey</a> or <a>GenerateDataKeyWithoutPlaintext</a> function. Data keys don't need to be encrypted again by calling <code>Encrypt</code>. </para> <para> If you want to encrypt data locally in your application, you can use the <code>GenerateDataKey</code> function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing. </para> </summary> <param name="request">Container for the necessary parameters to execute the Encrypt service method.</param> <returns>The response from the Encrypt service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantTokenException"> The request was rejected because a grant token provided as part of the request is invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidKeyUsageException"> The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KeyUnavailableException"> The request was rejected because the key was not available. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.EncryptAsync(Amazon.KeyManagementService.Model.EncryptRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Encrypt operation. </summary> <param name="request">Container for the necessary parameters to execute the Encrypt operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.GenerateDataKey(Amazon.KeyManagementService.Model.GenerateDataKeyRequest)"> <summary> Generates a data key that you can use in your application to locally encrypt data. This call returns a plaintext version of the key in the <code>Plaintext</code> field of the response object and an encrypted copy of the key in the <code>CiphertextBlob</code> field. The key is encrypted by using the master key specified by the <code>KeyId</code> field. To decrypt the encrypted key, pass it to the <code>Decrypt</code> API. <para> We recommend that you use the following pattern to locally encrypt data: call the <code>GenerateDataKey</code> API, use the key returned in the <code>Plaintext</code> response field to locally encrypt data, and then erase the plaintext data key from memory. Store the encrypted data key (contained in the <code>CiphertextBlob</code> field) alongside of the locally encrypted data. </para> <note>You should not call the <code>Encrypt</code> function to re-encrypt your data keys within a region. <code>GenerateDataKey</code> always returns the data key encrypted and tied to the customer master key that will be used to decrypt it. There is no need to decrypt it twice. </note> <para> If you decide to use the optional <code>EncryptionContext</code> parameter, you must also store the context in full or at least store enough information along with the encrypted data to be able to reconstruct the context when submitting the ciphertext to the <code>Decrypt</code> API. It is a good practice to choose a context that you can reconstruct on the fly to better secure the ciphertext. For more information about how this parameter is used, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/encrypt-context.html">Encryption Context</a>. </para> <para> To decrypt data, pass the encrypted data key to the <code>Decrypt</code> API. <code>Decrypt</code> uses the associated master key to decrypt the encrypted data key and returns it as plaintext. Use the plaintext data key to locally decrypt your data and then erase the key from memory. You must specify the encryption context, if any, that you specified when you generated the key. The encryption context is logged by CloudTrail, and you can use this log to help track the use of particular data. </para> </summary> <param name="request">Container for the necessary parameters to execute the GenerateDataKey service method.</param> <returns>The response from the GenerateDataKey service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantTokenException"> The request was rejected because a grant token provided as part of the request is invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidKeyUsageException"> The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KeyUnavailableException"> The request was rejected because the key was not available. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.GenerateDataKeyAsync(Amazon.KeyManagementService.Model.GenerateDataKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GenerateDataKey operation. </summary> <param name="request">Container for the necessary parameters to execute the GenerateDataKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.GenerateDataKeyWithoutPlaintext(Amazon.KeyManagementService.Model.GenerateDataKeyWithoutPlaintextRequest)"> <summary> Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like <a>GenerateDataKey</a>. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key. </summary> <param name="request">Container for the necessary parameters to execute the GenerateDataKeyWithoutPlaintext service method.</param> <returns>The response from the GenerateDataKeyWithoutPlaintext service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantTokenException"> The request was rejected because a grant token provided as part of the request is invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidKeyUsageException"> The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KeyUnavailableException"> The request was rejected because the key was not available. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.GenerateDataKeyWithoutPlaintextAsync(Amazon.KeyManagementService.Model.GenerateDataKeyWithoutPlaintextRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GenerateDataKeyWithoutPlaintext operation. </summary> <param name="request">Container for the necessary parameters to execute the GenerateDataKeyWithoutPlaintext operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.GenerateRandom(System.Int32)"> <summary> Generates an unpredictable byte string. </summary> <param name="numberOfBytes">Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. The current limit is 1024 bytes. </param> <returns>The response from the GenerateRandom service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.GenerateRandom(Amazon.KeyManagementService.Model.GenerateRandomRequest)"> <summary> Generates an unpredictable byte string. </summary> <param name="request">Container for the necessary parameters to execute the GenerateRandom service method.</param> <returns>The response from the GenerateRandom service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.GenerateRandomAsync(Amazon.KeyManagementService.Model.GenerateRandomRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GenerateRandom operation. </summary> <param name="request">Container for the necessary parameters to execute the GenerateRandom operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.GetKeyPolicy(System.String,System.String)"> <summary> Retrieves a policy attached to the specified key. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <param name="policyName">String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling <a>ListKeyPolicies</a>. </param> <returns>The response from the GetKeyPolicy service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.GetKeyPolicy(Amazon.KeyManagementService.Model.GetKeyPolicyRequest)"> <summary> Retrieves a policy attached to the specified key. </summary> <param name="request">Container for the necessary parameters to execute the GetKeyPolicy service method.</param> <returns>The response from the GetKeyPolicy service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.GetKeyPolicyAsync(Amazon.KeyManagementService.Model.GetKeyPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetKeyPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetKeyPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.GetKeyRotationStatus(System.String)"> <summary> Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <returns>The response from the GetKeyRotationStatus service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.GetKeyRotationStatus(Amazon.KeyManagementService.Model.GetKeyRotationStatusRequest)"> <summary> Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key. </summary> <param name="request">Container for the necessary parameters to execute the GetKeyRotationStatus service method.</param> <returns>The response from the GetKeyRotationStatus service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.GetKeyRotationStatusAsync(Amazon.KeyManagementService.Model.GetKeyRotationStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetKeyRotationStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the GetKeyRotationStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ListAliases(Amazon.KeyManagementService.Model.ListAliasesRequest)"> <summary> Lists all of the key aliases in the account. </summary> <param name="request">Container for the necessary parameters to execute the ListAliases service method.</param> <returns>The response from the ListAliases service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidMarkerException"> The request was rejected because the marker that specifies where pagination should next begin is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ListAliasesAsync(Amazon.KeyManagementService.Model.ListAliasesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAliases operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAliases operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ListGrants(Amazon.KeyManagementService.Model.ListGrantsRequest)"> <summary> List the grants for a specified key. </summary> <param name="request">Container for the necessary parameters to execute the ListGrants service method.</param> <returns>The response from the ListGrants service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidMarkerException"> The request was rejected because the marker that specifies where pagination should next begin is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ListGrantsAsync(Amazon.KeyManagementService.Model.ListGrantsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListGrants operation. </summary> <param name="request">Container for the necessary parameters to execute the ListGrants operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ListKeyPolicies(Amazon.KeyManagementService.Model.ListKeyPoliciesRequest)"> <summary> Retrieves a list of policies attached to a key. </summary> <param name="request">Container for the necessary parameters to execute the ListKeyPolicies service method.</param> <returns>The response from the ListKeyPolicies service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ListKeyPoliciesAsync(Amazon.KeyManagementService.Model.ListKeyPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListKeyPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListKeyPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ListKeys(Amazon.KeyManagementService.Model.ListKeysRequest)"> <summary> Lists the customer master keys. </summary> <param name="request">Container for the necessary parameters to execute the ListKeys service method.</param> <returns>The response from the ListKeys service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ListKeysAsync(Amazon.KeyManagementService.Model.ListKeysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListKeys operation. </summary> <param name="request">Container for the necessary parameters to execute the ListKeys operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ListRetirableGrants(System.String)"> <summary> Returns a list of all grants for which the grant's <code>RetiringPrincipal</code> matches the one specified. <para> A typical use is to list all grants that you are able to retire. To retire a grant, use <a>RetireGrant</a>. </para> </summary> <param name="retiringPrincipal">The retiring principal for which to list grants. To specify the retiring principal, use the <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, go to <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS Identity and Access Management (IAM)</a> in the Example ARNs section of the <i>Amazon Web Services General Reference</i>.</param> <returns>The response from the ListRetirableGrants service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidMarkerException"> The request was rejected because the marker that specifies where pagination should next begin is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ListRetirableGrants"> <summary> Returns a list of all grants for which the grant's <code>RetiringPrincipal</code> matches the one specified. <para> A typical use is to list all grants that you are able to retire. To retire a grant, use <a>RetireGrant</a>. </para> </summary> <returns>The response from the ListRetirableGrants service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidMarkerException"> The request was rejected because the marker that specifies where pagination should next begin is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ListRetirableGrants(Amazon.KeyManagementService.Model.ListRetirableGrantsRequest)"> <summary> Returns a list of all grants for which the grant's <code>RetiringPrincipal</code> matches the one specified. <para> A typical use is to list all grants that you are able to retire. To retire a grant, use <a>RetireGrant</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListRetirableGrants service method.</param> <returns>The response from the ListRetirableGrants service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidMarkerException"> The request was rejected because the marker that specifies where pagination should next begin is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ListRetirableGrantsAsync(Amazon.KeyManagementService.Model.ListRetirableGrantsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListRetirableGrants operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRetirableGrants operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.PutKeyPolicy(System.String,System.String,System.String)"> <summary> Attaches a policy to the specified key. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <param name="policy">The policy to attach to the key. This is required and delegates back to the account. The key is the root of trust. The policy size limit is 32 KiB (32768 bytes). </param> <param name="policyName">Name of the policy to be attached. Currently, the only supported name is "default".</param> <returns>The response from the PutKeyPolicy service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.LimitExceededException"> The request was rejected because a limit was exceeded. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>. </exception> <exception cref="T:Amazon.KeyManagementService.Model.MalformedPolicyDocumentException"> The request was rejected because the specified policy is not syntactically or semantically correct. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> <exception cref="T:Amazon.KeyManagementService.Model.UnsupportedOperationException"> The request was rejected because a specified parameter is not supported. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.PutKeyPolicy(Amazon.KeyManagementService.Model.PutKeyPolicyRequest)"> <summary> Attaches a policy to the specified key. </summary> <param name="request">Container for the necessary parameters to execute the PutKeyPolicy service method.</param> <returns>The response from the PutKeyPolicy service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.LimitExceededException"> The request was rejected because a limit was exceeded. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>. </exception> <exception cref="T:Amazon.KeyManagementService.Model.MalformedPolicyDocumentException"> The request was rejected because the specified policy is not syntactically or semantically correct. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> <exception cref="T:Amazon.KeyManagementService.Model.UnsupportedOperationException"> The request was rejected because a specified parameter is not supported. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.PutKeyPolicyAsync(Amazon.KeyManagementService.Model.PutKeyPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutKeyPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutKeyPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ReEncrypt(Amazon.KeyManagementService.Model.ReEncryptRequest)"> <summary> Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext. <para> Unlike other actions, <code>ReEncrypt</code> is authorized twice - once as <code>ReEncryptFrom</code> on the source key and once as <code>ReEncryptTo</code> on the destination key. We therefore recommend that you include the <code>"action":"kms:ReEncrypt*"</code> statement in your key policies to permit re-encryption from or to the key. The statement is included automatically when you authorize use of the key through the console but must be included manually when you set a policy by using the <a>PutKeyPolicy</a> function. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReEncrypt service method.</param> <returns>The response from the ReEncrypt service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidCiphertextException"> The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantTokenException"> The request was rejected because a grant token provided as part of the request is invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidKeyUsageException"> The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KeyUnavailableException"> The request was rejected because the key was not available. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ReEncryptAsync(Amazon.KeyManagementService.Model.ReEncryptRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReEncrypt operation. </summary> <param name="request">Container for the necessary parameters to execute the ReEncrypt operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.RetireGrant(System.String)"> <summary> Retires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API: <ul> <li>The account that created the grant</li> <li>The <code>RetiringPrincipal</code>, if present</li> <li>The <code>GranteePrincipal</code>, if <code>RetireGrant</code> is a grantee operation</li> </ul> The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the <code>CreateGrant</code> function. </summary> <param name="grantToken">Token that identifies the grant to be retired.</param> <returns>The response from the RetireGrant service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantIdException"> The request was rejected because the specified <code>GrantId</code> is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantTokenException"> The request was rejected because a grant token provided as part of the request is invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.RetireGrant(Amazon.KeyManagementService.Model.RetireGrantRequest)"> <summary> Retires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API: <ul> <li>The account that created the grant</li> <li>The <code>RetiringPrincipal</code>, if present</li> <li>The <code>GranteePrincipal</code>, if <code>RetireGrant</code> is a grantee operation</li> </ul> The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the <code>CreateGrant</code> function. </summary> <param name="request">Container for the necessary parameters to execute the RetireGrant service method.</param> <returns>The response from the RetireGrant service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantIdException"> The request was rejected because the specified <code>GrantId</code> is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantTokenException"> The request was rejected because a grant token provided as part of the request is invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.RetireGrantAsync(Amazon.KeyManagementService.Model.RetireGrantRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RetireGrant operation. </summary> <param name="request">Container for the necessary parameters to execute the RetireGrant operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.RevokeGrant(System.String,System.String)"> <summary> Revokes a grant. You can revoke a grant to actively deny operations that depend on it. </summary> <param name="grantId">Identifier of the grant to be revoked.</param> <param name="keyId">A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <returns>The response from the RevokeGrant service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantIdException"> The request was rejected because the specified <code>GrantId</code> is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.RevokeGrant(Amazon.KeyManagementService.Model.RevokeGrantRequest)"> <summary> Revokes a grant. You can revoke a grant to actively deny operations that depend on it. </summary> <param name="request">Container for the necessary parameters to execute the RevokeGrant service method.</param> <returns>The response from the RevokeGrant service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantIdException"> The request was rejected because the specified <code>GrantId</code> is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.RevokeGrantAsync(Amazon.KeyManagementService.Model.RevokeGrantRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RevokeGrant operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeGrant operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ScheduleKeyDeletion(System.String)"> <summary> Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to <code>PendingDeletion</code>. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that point to it. <important> <para> Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use <a>DisableKey</a>. </para> </important> <para> For more information about scheduling a CMK for deletion, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </summary> <param name="keyId">The unique identifier for the customer master key (CMK) to delete. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: <ul> <li>Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab</li> <li>Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</li> </ul> To obtain the unique key ID and key ARN for a given CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</param> <returns>The response from the ScheduleKeyDeletion service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ScheduleKeyDeletion(System.String,System.Int32)"> <summary> Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to <code>PendingDeletion</code>. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that point to it. <important> <para> Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use <a>DisableKey</a>. </para> </important> <para> For more information about scheduling a CMK for deletion, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </summary> <param name="keyId">The unique identifier for the customer master key (CMK) to delete. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: <ul> <li>Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab</li> <li>Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</li> </ul> To obtain the unique key ID and key ARN for a given CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</param> <param name="pendingWindowInDays">The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK). This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.</param> <returns>The response from the ScheduleKeyDeletion service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ScheduleKeyDeletion(Amazon.KeyManagementService.Model.ScheduleKeyDeletionRequest)"> <summary> Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to <code>PendingDeletion</code>. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that point to it. <important> <para> Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use <a>DisableKey</a>. </para> </important> <para> For more information about scheduling a CMK for deletion, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ScheduleKeyDeletion service method.</param> <returns>The response from the ScheduleKeyDeletion service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.ScheduleKeyDeletionAsync(Amazon.KeyManagementService.Model.ScheduleKeyDeletionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ScheduleKeyDeletion operation. </summary> <param name="request">Container for the necessary parameters to execute the ScheduleKeyDeletion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.UpdateAlias(System.String,System.String)"> <summary> Updates an alias to map it to a different key. <para> An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key. </para> <para> An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). </para> <para> The alias and the key it is mapped to must be in the same AWS account and the same region. </para> </summary> <param name="aliasName">String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.</param> <param name="targetKeyId">Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> You can call <a>ListAliases</a> to verify that the alias is mapped to the correct <code>TargetKeyId</code>.</param> <returns>The response from the UpdateAlias service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.UpdateAlias(Amazon.KeyManagementService.Model.UpdateAliasRequest)"> <summary> Updates an alias to map it to a different key. <para> An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key. </para> <para> An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). </para> <para> The alias and the key it is mapped to must be in the same AWS account and the same region. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAlias service method.</param> <returns>The response from the UpdateAlias service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.UpdateAliasAsync(Amazon.KeyManagementService.Model.UpdateAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.UpdateKeyDescription(System.String,System.String)"> <summary> Updates the description of a key. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <param name="description">New description for the key.</param> <returns>The response from the UpdateKeyDescription service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.UpdateKeyDescription(Amazon.KeyManagementService.Model.UpdateKeyDescriptionRequest)"> <summary> Updates the description of a key. </summary> <param name="request">Container for the necessary parameters to execute the UpdateKeyDescription service method.</param> <returns>The response from the UpdateKeyDescription service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.IAmazonKeyManagementService.UpdateKeyDescriptionAsync(Amazon.KeyManagementService.Model.UpdateKeyDescriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateKeyDescription operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateKeyDescription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.#ctor"> <summary> Constructs AmazonKeyManagementServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonKeyManagementServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.#ctor(Amazon.KeyManagementService.AmazonKeyManagementServiceConfig)"> <summary> Constructs AmazonKeyManagementServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonKeyManagementServiceClient Configuration Object</param> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonKeyManagementServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonKeyManagementServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.KeyManagementService.AmazonKeyManagementServiceConfig)"> <summary> Constructs AmazonKeyManagementServiceClient with AWS Credentials and an AmazonKeyManagementServiceClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonKeyManagementServiceClient Configuration Object</param> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonKeyManagementServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonKeyManagementServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.#ctor(System.String,System.String,Amazon.KeyManagementService.AmazonKeyManagementServiceConfig)"> <summary> Constructs AmazonKeyManagementServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonKeyManagementServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonKeyManagementServiceClient Configuration Object</param> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonKeyManagementServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonKeyManagementServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.#ctor(System.String,System.String,System.String,Amazon.KeyManagementService.AmazonKeyManagementServiceConfig)"> <summary> Constructs AmazonKeyManagementServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonKeyManagementServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonKeyManagementServiceClient Configuration Object</param> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.CancelKeyDeletion(System.String)"> <summary> Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the <code>Disabled</code> state. To enable a CMK, use <a>EnableKey</a>. <para> For more information about scheduling and canceling deletion of a CMK, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </summary> <param name="keyId">The unique identifier for the customer master key (CMK) for which to cancel deletion. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: <ul> <li>Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab</li> <li>Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</li> </ul> To obtain the unique key ID and key ARN for a given CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</param> <returns>The response from the CancelKeyDeletion service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.CancelKeyDeletion(Amazon.KeyManagementService.Model.CancelKeyDeletionRequest)"> <summary> Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the <code>Disabled</code> state. To enable a CMK, use <a>EnableKey</a>. <para> For more information about scheduling and canceling deletion of a CMK, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CancelKeyDeletion service method.</param> <returns>The response from the CancelKeyDeletion service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.CancelKeyDeletionAsync(Amazon.KeyManagementService.Model.CancelKeyDeletionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelKeyDeletion operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelKeyDeletion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.CreateAlias(System.String,System.String)"> <summary> Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). <para> The alias and the key it is mapped to must be in the same AWS account and the same region. </para> <para> To map an alias to a different key, call <a>UpdateAlias</a>. </para> </summary> <param name="aliasName">String that contains the display name. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved. </param> <param name="targetKeyId">An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <returns>The response from the CreateAlias service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.AlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidAliasNameException"> The request was rejected because the specified alias name is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.LimitExceededException"> The request was rejected because a limit was exceeded. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.CreateAlias(Amazon.KeyManagementService.Model.CreateAliasRequest)"> <summary> Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). <para> The alias and the key it is mapped to must be in the same AWS account and the same region. </para> <para> To map an alias to a different key, call <a>UpdateAlias</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateAlias service method.</param> <returns>The response from the CreateAlias service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.AlreadyExistsException"> The request was rejected because it attempted to create a resource that already exists. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidAliasNameException"> The request was rejected because the specified alias name is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.LimitExceededException"> The request was rejected because a limit was exceeded. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.CreateAliasAsync(Amazon.KeyManagementService.Model.CreateAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.CreateGrant(Amazon.KeyManagementService.Model.CreateGrantRequest)"> <summary> Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies. <para> For more information about grants, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Grants</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateGrant service method.</param> <returns>The response from the CreateGrant service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantTokenException"> The request was rejected because a grant token provided as part of the request is invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.LimitExceededException"> The request was rejected because a limit was exceeded. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.CreateGrantAsync(Amazon.KeyManagementService.Model.CreateGrantRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateGrant operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateGrant operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.CreateKey(Amazon.KeyManagementService.Model.CreateKeyRequest)"> <summary> Creates a customer master key. Customer master keys can be used to encrypt small amounts of data (less than 4K) directly, but they are most commonly used to encrypt or envelope data keys that are then used to encrypt customer data. For more information about data keys, see <a>GenerateDataKey</a> and <a>GenerateDataKeyWithoutPlaintext</a>. </summary> <param name="request">Container for the necessary parameters to execute the CreateKey service method.</param> <returns>The response from the CreateKey service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.LimitExceededException"> The request was rejected because a limit was exceeded. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>. </exception> <exception cref="T:Amazon.KeyManagementService.Model.MalformedPolicyDocumentException"> The request was rejected because the specified policy is not syntactically or semantically correct. </exception> <exception cref="T:Amazon.KeyManagementService.Model.UnsupportedOperationException"> The request was rejected because a specified parameter is not supported. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.CreateKeyAsync(Amazon.KeyManagementService.Model.CreateKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateKey operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.Decrypt(Amazon.KeyManagementService.Model.DecryptRequest)"> <summary> Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions: <ul> <li><a>GenerateDataKey</a></li> <li><a>GenerateDataKeyWithoutPlaintext</a></li> <li><a>Encrypt</a></li> </ul> <para> Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant <code>Decrypt</code> permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant <code>Decrypt</code> access in an IAM user policy. Instead grant <code>Decrypt</code> access only in key policies. If you must grant <code>Decrypt</code> access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts. </para> </summary> <param name="request">Container for the necessary parameters to execute the Decrypt service method.</param> <returns>The response from the Decrypt service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidCiphertextException"> The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantTokenException"> The request was rejected because a grant token provided as part of the request is invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KeyUnavailableException"> The request was rejected because the key was not available. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.DecryptAsync(Amazon.KeyManagementService.Model.DecryptRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Decrypt operation. </summary> <param name="request">Container for the necessary parameters to execute the Decrypt operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.DeleteAlias(System.String)"> <summary> Deletes the specified alias. To map an alias to a different key, call <a>UpdateAlias</a>. </summary> <param name="aliasName">The alias to be deleted. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.</param> <returns>The response from the DeleteAlias service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.DeleteAlias(Amazon.KeyManagementService.Model.DeleteAliasRequest)"> <summary> Deletes the specified alias. To map an alias to a different key, call <a>UpdateAlias</a>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAlias service method.</param> <returns>The response from the DeleteAlias service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.DeleteAliasAsync(Amazon.KeyManagementService.Model.DeleteAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.DescribeKey(System.String)"> <summary> Provides detailed information about the specified customer master key. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/". <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> <li>Alias Name Example - alias/MyAliasName</li> </ul> </param> <returns>The response from the DescribeKey service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.DescribeKey(Amazon.KeyManagementService.Model.DescribeKeyRequest)"> <summary> Provides detailed information about the specified customer master key. </summary> <param name="request">Container for the necessary parameters to execute the DescribeKey service method.</param> <returns>The response from the DescribeKey service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.DescribeKeyAsync(Amazon.KeyManagementService.Model.DescribeKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeKey operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.DisableKey(System.String)"> <summary> Sets the state of a master key to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a master key, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <returns>The response from the DisableKey service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.DisableKey(Amazon.KeyManagementService.Model.DisableKeyRequest)"> <summary> Sets the state of a master key to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a master key, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DisableKey service method.</param> <returns>The response from the DisableKey service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.DisableKeyAsync(Amazon.KeyManagementService.Model.DisableKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableKey operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.DisableKeyRotation(System.String)"> <summary> Disables rotation of the specified key. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <returns>The response from the DisableKeyRotation service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.DisableKeyRotation(Amazon.KeyManagementService.Model.DisableKeyRotationRequest)"> <summary> Disables rotation of the specified key. </summary> <param name="request">Container for the necessary parameters to execute the DisableKeyRotation service method.</param> <returns>The response from the DisableKeyRotation service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.DisableKeyRotationAsync(Amazon.KeyManagementService.Model.DisableKeyRotationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableKeyRotation operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableKeyRotation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.EnableKey(System.String)"> <summary> Marks a key as enabled, thereby permitting its use. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <returns>The response from the EnableKey service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.LimitExceededException"> The request was rejected because a limit was exceeded. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.EnableKey(Amazon.KeyManagementService.Model.EnableKeyRequest)"> <summary> Marks a key as enabled, thereby permitting its use. </summary> <param name="request">Container for the necessary parameters to execute the EnableKey service method.</param> <returns>The response from the EnableKey service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.LimitExceededException"> The request was rejected because a limit was exceeded. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.EnableKeyAsync(Amazon.KeyManagementService.Model.EnableKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableKey operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.EnableKeyRotation(System.String)"> <summary> Enables rotation of the specified customer master key. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <returns>The response from the EnableKeyRotation service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.EnableKeyRotation(Amazon.KeyManagementService.Model.EnableKeyRotationRequest)"> <summary> Enables rotation of the specified customer master key. </summary> <param name="request">Container for the necessary parameters to execute the EnableKeyRotation service method.</param> <returns>The response from the EnableKeyRotation service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.EnableKeyRotationAsync(Amazon.KeyManagementService.Model.EnableKeyRotationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableKeyRotation operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableKeyRotation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.Encrypt(Amazon.KeyManagementService.Model.EncryptRequest)"> <summary> Encrypts plaintext into ciphertext by using a customer master key. The <code>Encrypt</code> function has two primary use cases: <ul> <li>You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.</li> <li>If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data. </li> </ul> <para> Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the <a>GenerateDataKey</a> or <a>GenerateDataKeyWithoutPlaintext</a> function. Data keys don't need to be encrypted again by calling <code>Encrypt</code>. </para> <para> If you want to encrypt data locally in your application, you can use the <code>GenerateDataKey</code> function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing. </para> </summary> <param name="request">Container for the necessary parameters to execute the Encrypt service method.</param> <returns>The response from the Encrypt service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantTokenException"> The request was rejected because a grant token provided as part of the request is invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidKeyUsageException"> The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KeyUnavailableException"> The request was rejected because the key was not available. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.EncryptAsync(Amazon.KeyManagementService.Model.EncryptRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Encrypt operation. </summary> <param name="request">Container for the necessary parameters to execute the Encrypt operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.GenerateDataKey(Amazon.KeyManagementService.Model.GenerateDataKeyRequest)"> <summary> Generates a data key that you can use in your application to locally encrypt data. This call returns a plaintext version of the key in the <code>Plaintext</code> field of the response object and an encrypted copy of the key in the <code>CiphertextBlob</code> field. The key is encrypted by using the master key specified by the <code>KeyId</code> field. To decrypt the encrypted key, pass it to the <code>Decrypt</code> API. <para> We recommend that you use the following pattern to locally encrypt data: call the <code>GenerateDataKey</code> API, use the key returned in the <code>Plaintext</code> response field to locally encrypt data, and then erase the plaintext data key from memory. Store the encrypted data key (contained in the <code>CiphertextBlob</code> field) alongside of the locally encrypted data. </para> <note>You should not call the <code>Encrypt</code> function to re-encrypt your data keys within a region. <code>GenerateDataKey</code> always returns the data key encrypted and tied to the customer master key that will be used to decrypt it. There is no need to decrypt it twice. </note> <para> If you decide to use the optional <code>EncryptionContext</code> parameter, you must also store the context in full or at least store enough information along with the encrypted data to be able to reconstruct the context when submitting the ciphertext to the <code>Decrypt</code> API. It is a good practice to choose a context that you can reconstruct on the fly to better secure the ciphertext. For more information about how this parameter is used, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/encrypt-context.html">Encryption Context</a>. </para> <para> To decrypt data, pass the encrypted data key to the <code>Decrypt</code> API. <code>Decrypt</code> uses the associated master key to decrypt the encrypted data key and returns it as plaintext. Use the plaintext data key to locally decrypt your data and then erase the key from memory. You must specify the encryption context, if any, that you specified when you generated the key. The encryption context is logged by CloudTrail, and you can use this log to help track the use of particular data. </para> </summary> <param name="request">Container for the necessary parameters to execute the GenerateDataKey service method.</param> <returns>The response from the GenerateDataKey service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantTokenException"> The request was rejected because a grant token provided as part of the request is invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidKeyUsageException"> The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KeyUnavailableException"> The request was rejected because the key was not available. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.GenerateDataKeyAsync(Amazon.KeyManagementService.Model.GenerateDataKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GenerateDataKey operation. </summary> <param name="request">Container for the necessary parameters to execute the GenerateDataKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.GenerateDataKeyWithoutPlaintext(Amazon.KeyManagementService.Model.GenerateDataKeyWithoutPlaintextRequest)"> <summary> Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like <a>GenerateDataKey</a>. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key. </summary> <param name="request">Container for the necessary parameters to execute the GenerateDataKeyWithoutPlaintext service method.</param> <returns>The response from the GenerateDataKeyWithoutPlaintext service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantTokenException"> The request was rejected because a grant token provided as part of the request is invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidKeyUsageException"> The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KeyUnavailableException"> The request was rejected because the key was not available. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.GenerateDataKeyWithoutPlaintextAsync(Amazon.KeyManagementService.Model.GenerateDataKeyWithoutPlaintextRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GenerateDataKeyWithoutPlaintext operation. </summary> <param name="request">Container for the necessary parameters to execute the GenerateDataKeyWithoutPlaintext operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.GenerateRandom(System.Int32)"> <summary> Generates an unpredictable byte string. </summary> <param name="numberOfBytes">Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. The current limit is 1024 bytes. </param> <returns>The response from the GenerateRandom service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.GenerateRandom(Amazon.KeyManagementService.Model.GenerateRandomRequest)"> <summary> Generates an unpredictable byte string. </summary> <param name="request">Container for the necessary parameters to execute the GenerateRandom service method.</param> <returns>The response from the GenerateRandom service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.GenerateRandomAsync(Amazon.KeyManagementService.Model.GenerateRandomRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GenerateRandom operation. </summary> <param name="request">Container for the necessary parameters to execute the GenerateRandom operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.GetKeyPolicy(System.String,System.String)"> <summary> Retrieves a policy attached to the specified key. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <param name="policyName">String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling <a>ListKeyPolicies</a>. </param> <returns>The response from the GetKeyPolicy service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.GetKeyPolicy(Amazon.KeyManagementService.Model.GetKeyPolicyRequest)"> <summary> Retrieves a policy attached to the specified key. </summary> <param name="request">Container for the necessary parameters to execute the GetKeyPolicy service method.</param> <returns>The response from the GetKeyPolicy service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.GetKeyPolicyAsync(Amazon.KeyManagementService.Model.GetKeyPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetKeyPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetKeyPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.GetKeyRotationStatus(System.String)"> <summary> Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <returns>The response from the GetKeyRotationStatus service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.GetKeyRotationStatus(Amazon.KeyManagementService.Model.GetKeyRotationStatusRequest)"> <summary> Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key. </summary> <param name="request">Container for the necessary parameters to execute the GetKeyRotationStatus service method.</param> <returns>The response from the GetKeyRotationStatus service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.GetKeyRotationStatusAsync(Amazon.KeyManagementService.Model.GetKeyRotationStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetKeyRotationStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the GetKeyRotationStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ListAliases(Amazon.KeyManagementService.Model.ListAliasesRequest)"> <summary> Lists all of the key aliases in the account. </summary> <param name="request">Container for the necessary parameters to execute the ListAliases service method.</param> <returns>The response from the ListAliases service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidMarkerException"> The request was rejected because the marker that specifies where pagination should next begin is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ListAliasesAsync(Amazon.KeyManagementService.Model.ListAliasesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAliases operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAliases operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ListGrants(Amazon.KeyManagementService.Model.ListGrantsRequest)"> <summary> List the grants for a specified key. </summary> <param name="request">Container for the necessary parameters to execute the ListGrants service method.</param> <returns>The response from the ListGrants service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidMarkerException"> The request was rejected because the marker that specifies where pagination should next begin is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ListGrantsAsync(Amazon.KeyManagementService.Model.ListGrantsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListGrants operation. </summary> <param name="request">Container for the necessary parameters to execute the ListGrants operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ListKeyPolicies(Amazon.KeyManagementService.Model.ListKeyPoliciesRequest)"> <summary> Retrieves a list of policies attached to a key. </summary> <param name="request">Container for the necessary parameters to execute the ListKeyPolicies service method.</param> <returns>The response from the ListKeyPolicies service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ListKeyPoliciesAsync(Amazon.KeyManagementService.Model.ListKeyPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListKeyPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListKeyPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ListKeys(Amazon.KeyManagementService.Model.ListKeysRequest)"> <summary> Lists the customer master keys. </summary> <param name="request">Container for the necessary parameters to execute the ListKeys service method.</param> <returns>The response from the ListKeys service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ListKeysAsync(Amazon.KeyManagementService.Model.ListKeysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListKeys operation. </summary> <param name="request">Container for the necessary parameters to execute the ListKeys operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ListRetirableGrants(System.String)"> <summary> Returns a list of all grants for which the grant's <code>RetiringPrincipal</code> matches the one specified. <para> A typical use is to list all grants that you are able to retire. To retire a grant, use <a>RetireGrant</a>. </para> </summary> <param name="retiringPrincipal">The retiring principal for which to list grants. To specify the retiring principal, use the <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, go to <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS Identity and Access Management (IAM)</a> in the Example ARNs section of the <i>Amazon Web Services General Reference</i>.</param> <returns>The response from the ListRetirableGrants service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidMarkerException"> The request was rejected because the marker that specifies where pagination should next begin is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ListRetirableGrants"> <summary> Returns a list of all grants for which the grant's <code>RetiringPrincipal</code> matches the one specified. <para> A typical use is to list all grants that you are able to retire. To retire a grant, use <a>RetireGrant</a>. </para> </summary> <returns>The response from the ListRetirableGrants service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidMarkerException"> The request was rejected because the marker that specifies where pagination should next begin is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ListRetirableGrants(Amazon.KeyManagementService.Model.ListRetirableGrantsRequest)"> <summary> Returns a list of all grants for which the grant's <code>RetiringPrincipal</code> matches the one specified. <para> A typical use is to list all grants that you are able to retire. To retire a grant, use <a>RetireGrant</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListRetirableGrants service method.</param> <returns>The response from the ListRetirableGrants service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidMarkerException"> The request was rejected because the marker that specifies where pagination should next begin is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ListRetirableGrantsAsync(Amazon.KeyManagementService.Model.ListRetirableGrantsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListRetirableGrants operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRetirableGrants operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.PutKeyPolicy(System.String,System.String,System.String)"> <summary> Attaches a policy to the specified key. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <param name="policy">The policy to attach to the key. This is required and delegates back to the account. The key is the root of trust. The policy size limit is 32 KiB (32768 bytes). </param> <param name="policyName">Name of the policy to be attached. Currently, the only supported name is "default".</param> <returns>The response from the PutKeyPolicy service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.LimitExceededException"> The request was rejected because a limit was exceeded. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>. </exception> <exception cref="T:Amazon.KeyManagementService.Model.MalformedPolicyDocumentException"> The request was rejected because the specified policy is not syntactically or semantically correct. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> <exception cref="T:Amazon.KeyManagementService.Model.UnsupportedOperationException"> The request was rejected because a specified parameter is not supported. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.PutKeyPolicy(Amazon.KeyManagementService.Model.PutKeyPolicyRequest)"> <summary> Attaches a policy to the specified key. </summary> <param name="request">Container for the necessary parameters to execute the PutKeyPolicy service method.</param> <returns>The response from the PutKeyPolicy service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.LimitExceededException"> The request was rejected because a limit was exceeded. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>. </exception> <exception cref="T:Amazon.KeyManagementService.Model.MalformedPolicyDocumentException"> The request was rejected because the specified policy is not syntactically or semantically correct. </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> <exception cref="T:Amazon.KeyManagementService.Model.UnsupportedOperationException"> The request was rejected because a specified parameter is not supported. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.PutKeyPolicyAsync(Amazon.KeyManagementService.Model.PutKeyPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutKeyPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutKeyPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ReEncrypt(Amazon.KeyManagementService.Model.ReEncryptRequest)"> <summary> Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext. <para> Unlike other actions, <code>ReEncrypt</code> is authorized twice - once as <code>ReEncryptFrom</code> on the source key and once as <code>ReEncryptTo</code> on the destination key. We therefore recommend that you include the <code>"action":"kms:ReEncrypt*"</code> statement in your key policies to permit re-encryption from or to the key. The statement is included automatically when you authorize use of the key through the console but must be included manually when you set a policy by using the <a>PutKeyPolicy</a> function. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReEncrypt service method.</param> <returns>The response from the ReEncrypt service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.DisabledException"> The request was rejected because the specified key was marked as disabled. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidCiphertextException"> The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantTokenException"> The request was rejected because a grant token provided as part of the request is invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidKeyUsageException"> The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KeyUnavailableException"> The request was rejected because the key was not available. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ReEncryptAsync(Amazon.KeyManagementService.Model.ReEncryptRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReEncrypt operation. </summary> <param name="request">Container for the necessary parameters to execute the ReEncrypt operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.RetireGrant(System.String)"> <summary> Retires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API: <ul> <li>The account that created the grant</li> <li>The <code>RetiringPrincipal</code>, if present</li> <li>The <code>GranteePrincipal</code>, if <code>RetireGrant</code> is a grantee operation</li> </ul> The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the <code>CreateGrant</code> function. </summary> <param name="grantToken">Token that identifies the grant to be retired.</param> <returns>The response from the RetireGrant service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantIdException"> The request was rejected because the specified <code>GrantId</code> is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantTokenException"> The request was rejected because a grant token provided as part of the request is invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.RetireGrant(Amazon.KeyManagementService.Model.RetireGrantRequest)"> <summary> Retires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API: <ul> <li>The account that created the grant</li> <li>The <code>RetiringPrincipal</code>, if present</li> <li>The <code>GranteePrincipal</code>, if <code>RetireGrant</code> is a grantee operation</li> </ul> The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the <code>CreateGrant</code> function. </summary> <param name="request">Container for the necessary parameters to execute the RetireGrant service method.</param> <returns>The response from the RetireGrant service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantIdException"> The request was rejected because the specified <code>GrantId</code> is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantTokenException"> The request was rejected because a grant token provided as part of the request is invalid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.RetireGrantAsync(Amazon.KeyManagementService.Model.RetireGrantRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RetireGrant operation. </summary> <param name="request">Container for the necessary parameters to execute the RetireGrant operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.RevokeGrant(System.String,System.String)"> <summary> Revokes a grant. You can revoke a grant to actively deny operations that depend on it. </summary> <param name="grantId">Identifier of the grant to be revoked.</param> <param name="keyId">A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <returns>The response from the RevokeGrant service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantIdException"> The request was rejected because the specified <code>GrantId</code> is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.RevokeGrant(Amazon.KeyManagementService.Model.RevokeGrantRequest)"> <summary> Revokes a grant. You can revoke a grant to actively deny operations that depend on it. </summary> <param name="request">Container for the necessary parameters to execute the RevokeGrant service method.</param> <returns>The response from the RevokeGrant service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidGrantIdException"> The request was rejected because the specified <code>GrantId</code> is not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.RevokeGrantAsync(Amazon.KeyManagementService.Model.RevokeGrantRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RevokeGrant operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeGrant operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ScheduleKeyDeletion(System.String)"> <summary> Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to <code>PendingDeletion</code>. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that point to it. <important> <para> Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use <a>DisableKey</a>. </para> </important> <para> For more information about scheduling a CMK for deletion, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </summary> <param name="keyId">The unique identifier for the customer master key (CMK) to delete. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: <ul> <li>Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab</li> <li>Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</li> </ul> To obtain the unique key ID and key ARN for a given CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</param> <returns>The response from the ScheduleKeyDeletion service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ScheduleKeyDeletion(System.String,System.Int32)"> <summary> Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to <code>PendingDeletion</code>. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that point to it. <important> <para> Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use <a>DisableKey</a>. </para> </important> <para> For more information about scheduling a CMK for deletion, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </summary> <param name="keyId">The unique identifier for the customer master key (CMK) to delete. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: <ul> <li>Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab</li> <li>Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</li> </ul> To obtain the unique key ID and key ARN for a given CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</param> <param name="pendingWindowInDays">The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK). This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.</param> <returns>The response from the ScheduleKeyDeletion service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ScheduleKeyDeletion(Amazon.KeyManagementService.Model.ScheduleKeyDeletionRequest)"> <summary> Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to <code>PendingDeletion</code>. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that point to it. <important> <para> Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use <a>DisableKey</a>. </para> </important> <para> For more information about scheduling a CMK for deletion, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ScheduleKeyDeletion service method.</param> <returns>The response from the ScheduleKeyDeletion service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ScheduleKeyDeletionAsync(Amazon.KeyManagementService.Model.ScheduleKeyDeletionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ScheduleKeyDeletion operation. </summary> <param name="request">Container for the necessary parameters to execute the ScheduleKeyDeletion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.UpdateAlias(System.String,System.String)"> <summary> Updates an alias to map it to a different key. <para> An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key. </para> <para> An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). </para> <para> The alias and the key it is mapped to must be in the same AWS account and the same region. </para> </summary> <param name="aliasName">String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.</param> <param name="targetKeyId">Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> You can call <a>ListAliases</a> to verify that the alias is mapped to the correct <code>TargetKeyId</code>.</param> <returns>The response from the UpdateAlias service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.UpdateAlias(Amazon.KeyManagementService.Model.UpdateAliasRequest)"> <summary> Updates an alias to map it to a different key. <para> An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key. </para> <para> An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). </para> <para> The alias and the key it is mapped to must be in the same AWS account and the same region. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAlias service method.</param> <returns>The response from the UpdateAlias service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.UpdateAliasAsync(Amazon.KeyManagementService.Model.UpdateAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.UpdateKeyDescription(System.String,System.String)"> <summary> Updates the description of a key. </summary> <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param> <param name="description">New description for the key.</param> <returns>The response from the UpdateKeyDescription service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.UpdateKeyDescription(Amazon.KeyManagementService.Model.UpdateKeyDescriptionRequest)"> <summary> Updates the description of a key. </summary> <param name="request">Container for the necessary parameters to execute the UpdateKeyDescription service method.</param> <returns>The response from the UpdateKeyDescription service method, as returned by KeyManagementService.</returns> <exception cref="T:Amazon.KeyManagementService.Model.DependencyTimeoutException"> The system timed out while trying to fulfill the request. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.InvalidArnException"> The request was rejected because a specified ARN was not valid. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInternalException"> The request was rejected because an internal exception occurred. The request can be retried. </exception> <exception cref="T:Amazon.KeyManagementService.Model.KMSInvalidStateException"> The request was rejected because the state of the specified resource is not valid for this request. <para> For more information about how key state affects the use of a customer master key (CMK), go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </exception> <exception cref="T:Amazon.KeyManagementService.Model.NotFoundException"> The request was rejected because the specified entity or resource could not be found. </exception> </member> <member name="M:Amazon.KeyManagementService.AmazonKeyManagementServiceClient.UpdateKeyDescriptionAsync(Amazon.KeyManagementService.Model.UpdateKeyDescriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateKeyDescription operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateKeyDescription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.Kinesis.AmazonKinesisClient"> <summary> Implementation for accessing Kinesis Amazon Kinesis Service API Reference <para> Amazon Kinesis is a managed service that scales elastically for real time processing of streaming big data. </para> </summary> </member> <member name="T:Amazon.Kinesis.IAmazonKinesis"> <summary> Interface for accessing Kinesis Amazon Kinesis Service API Reference <para> Amazon Kinesis is a managed service that scales elastically for real time processing of streaming big data. </para> </summary> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.AddTagsToStream(Amazon.Kinesis.Model.AddTagsToStreamRequest)"> <summary> Adds or updates tags for the specified Amazon Kinesis stream. Each stream can have up to 10 tags. <para> If tags have already been assigned to the stream, <code>AddTagsToStream</code> overwrites any existing tags that correspond to the specified tag keys. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToStream service method.</param> <returns>The response from the AddTagsToStream service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.AddTagsToStreamAsync(Amazon.Kinesis.Model.AddTagsToStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTagsToStream operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.CreateStream(Amazon.Kinesis.Model.CreateStreamRequest)"> <summary> Creates a Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or <i>producers</i>. Scale-out within an Amazon Kinesis stream is explicitly supported by means of shards, which are uniquely identified groups of data records in an Amazon Kinesis stream. <para> You specify and control the number of shards that a stream is composed of. Each shard can support reads up to 5 transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases. </para> <para> The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name. </para> <para> <code>CreateStream</code> is an asynchronous operation. Upon receiving a <code>CreateStream</code> request, Amazon Kinesis immediately returns and sets the stream status to <code>CREATING</code>. After the stream is created, Amazon Kinesis sets the stream status to <code>ACTIVE</code>. You should perform read and write operations only on an <code>ACTIVE</code> stream. </para> <para> You receive a <code>LimitExceededException</code> when making a <code>CreateStream</code> request if you try to do one of the following: </para> <ul> <li>Have more than five streams in the <code>CREATING</code> state at any point in time.</li> <li>Create more shards than are authorized for your account.</li> </ul> <para> For the default shard limit for an AWS account, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Amazon Kinesis Limits</a>. If you need to increase this limit, <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">contact AWS Support</a>. </para> <para> You can use <code>DescribeStream</code> to check the stream status, which is returned in <code>StreamStatus</code>. </para> <para> <a>CreateStream</a> has a limit of 5 transactions per second per account. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateStream service method.</param> <returns>The response from the CreateStream service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.CreateStreamAsync(Amazon.Kinesis.Model.CreateStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateStream operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.DecreaseStreamRetentionPeriod(System.String,System.Int32)"> <summary> Decreases the stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream’s retention period is 24 hours. <para> This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible. </para> </summary> <param name="streamName">The name of the stream to modify.</param> <param name="retentionPeriodHours">The new retention period of the stream, in hours. Must be less than the current retention period.</param> <returns>The response from the DecreaseStreamRetentionPeriod service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.DecreaseStreamRetentionPeriod(Amazon.Kinesis.Model.DecreaseStreamRetentionPeriodRequest)"> <summary> Decreases the stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream’s retention period is 24 hours. <para> This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible. </para> </summary> <param name="request">Container for the necessary parameters to execute the DecreaseStreamRetentionPeriod service method.</param> <returns>The response from the DecreaseStreamRetentionPeriod service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.DecreaseStreamRetentionPeriodAsync(Amazon.Kinesis.Model.DecreaseStreamRetentionPeriodRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DecreaseStreamRetentionPeriod operation. </summary> <param name="request">Container for the necessary parameters to execute the DecreaseStreamRetentionPeriod operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.DeleteStream(Amazon.Kinesis.Model.DeleteStreamRequest)"> <summary> Deletes a stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it will receive the exception <code>ResourceNotFoundException</code>. <para> If the stream is in the <code>ACTIVE</code> state, you can delete it. After a <code>DeleteStream</code> request, the specified stream is in the <code>DELETING</code> state until Amazon Kinesis completes the deletion. </para> <para> <b>Note:</b> Amazon Kinesis might continue to accept data read and write operations, such as <a>PutRecord</a>, <a>PutRecords</a>, and <a>GetRecords</a>, on a stream in the <code>DELETING</code> state until the stream deletion is complete. </para> <para> When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream. </para> <para> You can use the <a>DescribeStream</a> operation to check the state of the stream, which is returned in <code>StreamStatus</code>. </para> <para> <a>DeleteStream</a> has a limit of 5 transactions per second per account. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteStream service method.</param> <returns>The response from the DeleteStream service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.DeleteStreamAsync(Amazon.Kinesis.Model.DeleteStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteStream operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.DescribeStream(Amazon.Kinesis.Model.DescribeStreamRequest)"> <summary> Describes the specified stream. <para> The information about the stream includes its current status, its Amazon Resource Name (ARN), and an array of shard objects. For each shard object, there is information about the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream. </para> <para> You can limit the number of returned shards using the <code>Limit</code> parameter. The number of shards in a stream may be too large to return from a single call to <code>DescribeStream</code>. You can detect this by using the <code>HasMoreShards</code> flag in the returned output. <code>HasMoreShards</code> is set to <code>true</code> when there is more data available. </para> <para> <code>DescribeStream</code> is a paginated operation. If there are more shards available, you can request them using the shard ID of the last shard returned. Specify this ID in the <code>ExclusiveStartShardId</code> parameter in a subsequent request to <code>DescribeStream</code>. </para> <para> <a>DescribeStream</a> has a limit of 10 transactions per second per account. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStream service method.</param> <returns>The response from the DescribeStream service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.DescribeStreamAsync(Amazon.Kinesis.Model.DescribeStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStream operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.GetRecords(Amazon.Kinesis.Model.GetRecordsRequest)"> <summary> Gets data records from a shard. <para> Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, <a>GetRecords</a> returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains records. </para> <para> You can scale by provisioning multiple shards. Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call <a>GetRecords</a> in a loop. Use <a>GetShardIterator</a> to get the shard iterator to specify in the first <a>GetRecords</a> call. <a>GetRecords</a> returns a new shard iterator in <code>NextShardIterator</code>. Specify the shard iterator returned in <code>NextShardIterator</code> in subsequent calls to <a>GetRecords</a>. Note that if the shard has been closed, the shard iterator can't return more data and <a>GetRecords</a> returns <code>null</code> in <code>NextShardIterator</code>. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process. </para> <para> Each data record can be up to 1 MB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the <code>Limit</code> parameter to specify the maximum number of records that <a>GetRecords</a> can return. Consider your average record size when determining this limit. </para> <para> The size of the data returned by <a>GetRecords</a> will vary depending on the utilization of the shard. The maximum size of data that <a>GetRecords</a> can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw <code>ProvisionedThroughputExceededException</code>. If there is insufficient provisioned throughput on the shard, subsequent calls made within the next 1 second throw <code>ProvisionedThroughputExceededException</code>. Note that <a>GetRecords</a> won't return any data when it throws an exception. For this reason, we recommend that you wait one second between calls to <a>GetRecords</a>; however, it's possible that the application will get exceptions for longer than 1 second. </para> <para> To detect whether the application is falling behind in processing, you can use the <code>MillisBehindLatest</code> response attribute. You can also monitor the stream using CloudWatch metrics (see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html">Monitoring Amazon Kinesis</a> in the <i>Amazon Kinesis Developer Guide</i>). </para> <para> Each Amazon Kinesis record includes a value, <code>ApproximateArrivalTimestamp</code>, that is set when an Amazon Kinesis stream successfully receives and stores a record. This is commonly referred to as a server-side timestamp, which is different than a client-side timestamp, where the timestamp is set when a data producer creates or sends the record to a stream. The timestamp has millisecond precision. There are no guarantees about the timestamp accuracy, or that the timestamp is always increasing. For example, records in a shard or across a stream might have timestamps that are out of order. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetRecords service method.</param> <returns>The response from the GetRecords service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.ExpiredIteratorException"> The provided iterator exceeds the maximum age allowed. </exception> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.ProvisionedThroughputExceededException"> The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/api-retries.html" target="_blank">Error Retries and Exponential Backoff in AWS</a> in the <i>AWS General Reference</i>. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.GetRecordsAsync(Amazon.Kinesis.Model.GetRecordsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetRecords operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRecords operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.GetShardIterator(Amazon.Kinesis.Model.GetShardIteratorRequest)"> <summary> Gets a shard iterator. A shard iterator expires five minutes after it is returned to the requester. <para> A shard iterator specifies the position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream. </para> <para> You must specify the shard iterator type. For example, you can set the <code>ShardIteratorType</code> parameter to read exactly from the position denoted by a specific sequence number by using the <code>AT_SEQUENCE_NUMBER</code> shard iterator type, or right after the sequence number by using the <code>AFTER_SEQUENCE_NUMBER</code> shard iterator type, using sequence numbers returned by earlier calls to <a>PutRecord</a>, <a>PutRecords</a>, <a>GetRecords</a>, or <a>DescribeStream</a>. You can specify the shard iterator type <code>TRIM_HORIZON</code> in the request to cause <code>ShardIterator</code> to point to the last untrimmed record in the shard in the system, which is the oldest data record in the shard. Or you can point to just after the most recent record in the shard, by using the shard iterator type <code>LATEST</code>, so that you always read the most recent data in the shard. </para> <para> When you repeatedly read from an Amazon Kinesis stream use a <a>GetShardIterator</a> request to get the first shard iterator for use in your first <a>GetRecords</a> request and then use the shard iterator returned by the <a>GetRecords</a> request in <code>NextShardIterator</code> for subsequent reads. A new shard iterator is returned by every <a>GetRecords</a> request in <code>NextShardIterator</code>, which you use in the <code>ShardIterator</code> parameter of the next <a>GetRecords</a> request. </para> <para> If a <a>GetShardIterator</a> request is made too often, you receive a <code>ProvisionedThroughputExceededException</code>. For more information about throughput limits, see <a>GetRecords</a>. </para> <para> If the shard is closed, the iterator can't return more data, and <a>GetShardIterator</a> returns <code>null</code> for its <code>ShardIterator</code>. A shard can be closed using <a>SplitShard</a> or <a>MergeShards</a>. </para> <para> <a>GetShardIterator</a> has a limit of 5 transactions per second per account per open shard. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetShardIterator service method.</param> <returns>The response from the GetShardIterator service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.ProvisionedThroughputExceededException"> The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/api-retries.html" target="_blank">Error Retries and Exponential Backoff in AWS</a> in the <i>AWS General Reference</i>. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.GetShardIteratorAsync(Amazon.Kinesis.Model.GetShardIteratorRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetShardIterator operation. </summary> <param name="request">Container for the necessary parameters to execute the GetShardIterator operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.IncreaseStreamRetentionPeriod(System.String,System.Int32)"> <summary> Increases the stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream’s retention period is 168 hours (7 days). <para> Upon choosing a longer stream retention period, this operation will increase the time period records are accessible that have not yet expired. However, it will not make previous data that has expired (older than the stream’s previous retention period) accessible after the operation has been called. For example, if a stream’s retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours will remain inaccessible to consumer applications. </para> </summary> <param name="streamName">The name of the stream to modify.</param> <param name="retentionPeriodHours">The new retention period of the stream, in hours. Must be more than the current retention period.</param> <returns>The response from the IncreaseStreamRetentionPeriod service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.IncreaseStreamRetentionPeriod(Amazon.Kinesis.Model.IncreaseStreamRetentionPeriodRequest)"> <summary> Increases the stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream’s retention period is 168 hours (7 days). <para> Upon choosing a longer stream retention period, this operation will increase the time period records are accessible that have not yet expired. However, it will not make previous data that has expired (older than the stream’s previous retention period) accessible after the operation has been called. For example, if a stream’s retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours will remain inaccessible to consumer applications. </para> </summary> <param name="request">Container for the necessary parameters to execute the IncreaseStreamRetentionPeriod service method.</param> <returns>The response from the IncreaseStreamRetentionPeriod service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.IncreaseStreamRetentionPeriodAsync(Amazon.Kinesis.Model.IncreaseStreamRetentionPeriodRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the IncreaseStreamRetentionPeriod operation. </summary> <param name="request">Container for the necessary parameters to execute the IncreaseStreamRetentionPeriod operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.ListStreams"> <summary> Lists your streams. <para> The number of streams may be too large to return from a single call to <code>ListStreams</code>. You can limit the number of returned streams using the <code>Limit</code> parameter. If you do not specify a value for the <code>Limit</code> parameter, Amazon Kinesis uses the default limit, which is currently 10. </para> <para> You can detect if there are more streams available to list by using the <code>HasMoreStreams</code> flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the <code>ListStreams</code> request in the <code>ExclusiveStartStreamName</code> parameter in a subsequent request to <code>ListStreams</code>. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list. </para> <para> <a>ListStreams</a> has a limit of 5 transactions per second per account. </para> </summary> <returns>The response from the ListStreams service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.ListStreams(Amazon.Kinesis.Model.ListStreamsRequest)"> <summary> Lists your streams. <para> The number of streams may be too large to return from a single call to <code>ListStreams</code>. You can limit the number of returned streams using the <code>Limit</code> parameter. If you do not specify a value for the <code>Limit</code> parameter, Amazon Kinesis uses the default limit, which is currently 10. </para> <para> You can detect if there are more streams available to list by using the <code>HasMoreStreams</code> flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the <code>ListStreams</code> request in the <code>ExclusiveStartStreamName</code> parameter in a subsequent request to <code>ListStreams</code>. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list. </para> <para> <a>ListStreams</a> has a limit of 5 transactions per second per account. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListStreams service method.</param> <returns>The response from the ListStreams service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.ListStreamsAsync(Amazon.Kinesis.Model.ListStreamsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListStreams operation. </summary> <param name="request">Container for the necessary parameters to execute the ListStreams operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.ListTagsForStream(Amazon.Kinesis.Model.ListTagsForStreamRequest)"> <summary> Lists the tags for the specified Amazon Kinesis stream. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForStream service method.</param> <returns>The response from the ListTagsForStream service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.ListTagsForStreamAsync(Amazon.Kinesis.Model.ListTagsForStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTagsForStream operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.MergeShards(Amazon.Kinesis.Model.MergeShardsRequest)"> <summary> Merges two adjacent shards in a stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards. <para> <code>MergeShards</code> is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html">Merge Two Shards</a> in the <i>Amazon Kinesis Developer Guide</i>. </para> <para> If the stream is in the <code>ACTIVE</code> state, you can call <code>MergeShards</code>. If a stream is in the <code>CREATING</code>, <code>UPDATING</code>, or <code>DELETING</code> state, <code>MergeShards</code> returns a <code>ResourceInUseException</code>. If the specified stream does not exist, <code>MergeShards</code> returns a <code>ResourceNotFoundException</code>. </para> <para> You can use <a>DescribeStream</a> to check the state of the stream, which is returned in <code>StreamStatus</code>. </para> <para> <code>MergeShards</code> is an asynchronous operation. Upon receiving a <code>MergeShards</code> request, Amazon Kinesis immediately returns a response and sets the <code>StreamStatus</code> to <code>UPDATING</code>. After the operation is completed, Amazon Kinesis sets the <code>StreamStatus</code> to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </para> <para> You use <a>DescribeStream</a> to determine the shard IDs that are specified in the <code>MergeShards</code> request. </para> <para> If you try to operate on too many streams in parallel using <a>CreateStream</a>, <a>DeleteStream</a>, <code>MergeShards</code> or <a>SplitShard</a>, you will receive a <code>LimitExceededException</code>. </para> <para> <code>MergeShards</code> has limit of 5 transactions per second per account. </para> </summary> <param name="request">Container for the necessary parameters to execute the MergeShards service method.</param> <returns>The response from the MergeShards service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.MergeShardsAsync(Amazon.Kinesis.Model.MergeShardsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the MergeShards operation. </summary> <param name="request">Container for the necessary parameters to execute the MergeShards operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.PutRecord(Amazon.Kinesis.Model.PutRecordRequest)"> <summary> Writes a single data record from a producer into an Amazon Kinesis stream. Call <code>PutRecord</code> to send data from the producer into the Amazon Kinesis stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. <para> You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself. </para> <para> The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on. </para> <para> The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a data stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to. </para> <para> Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the <code>ExplicitHashKey</code> parameter. For more information, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream">Adding Data to a Stream</a> in the <i>Amazon Kinesis Developer Guide</i>. </para> <para> <code>PutRecord</code> returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record. </para> <para> Sequence numbers generally increase over time. To guarantee strictly increasing ordering, use the <code>SequenceNumberForOrdering</code> parameter. For more information, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream">Adding Data to a Stream</a> in the <i>Amazon Kinesis Developer Guide</i>. </para> <para> If a <code>PutRecord</code> request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, <code>PutRecord</code> throws <code>ProvisionedThroughputExceededException</code>. </para> <para> By default, data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream. This retention period can be modified using the <a>DecreaseStreamRetentionPeriod</a> and <a>IncreaseStreamRetentionPeriod</a> operations. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutRecord service method.</param> <returns>The response from the PutRecord service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.ProvisionedThroughputExceededException"> The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/api-retries.html" target="_blank">Error Retries and Exponential Backoff in AWS</a> in the <i>AWS General Reference</i>. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.PutRecordAsync(Amazon.Kinesis.Model.PutRecordRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutRecord operation. </summary> <param name="request">Container for the necessary parameters to execute the PutRecord operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.PutRecords(Amazon.Kinesis.Model.PutRecordsRequest)"> <summary> Writes multiple data records from a producer into an Amazon Kinesis stream in a single call (also referred to as a <code>PutRecords</code> request). Use this operation to send data from a data producer into the Amazon Kinesis stream for data ingestion and processing. <para> Each <code>PutRecords</code> request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. </para> <para> You must specify the name of the stream that captures, stores, and transports the data; and an array of request <code>Records</code>, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob. </para> <para> The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on. </para> <para> The partition key is used by Amazon Kinesis as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream">Adding Data to a Stream</a> in the <i>Amazon Kinesis Developer Guide</i>. </para> <para> Each record in the <code>Records</code> array may include an optional parameter, <code>ExplicitHashKey</code>, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis Developer Guide</i>. </para> <para> The <code>PutRecords</code> response includes an array of response <code>Records</code>. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response <code>Records</code> array always includes the same number of records as the request array. </para> <para> The response <code>Records</code> array includes both successfully and unsuccessfully processed records. Amazon Kinesis attempts to process all records in each <code>PutRecords</code> request. A single record failure does not stop the processing of subsequent records. </para> <para> A successfully-processed record includes <code>ShardId</code> and <code>SequenceNumber</code> values. The <code>ShardId</code> parameter identifies the shard in the stream where the record is stored. The <code>SequenceNumber</code> parameter is an identifier assigned to the put record, unique to all records in the stream. </para> <para> An unsuccessfully-processed record includes <code>ErrorCode</code> and <code>ErrorMessage</code> values. <code>ErrorCode</code> reflects the type of error and can be one of the following values: <code>ProvisionedThroughputExceededException</code> or <code>InternalFailure</code>. <code>ErrorMessage</code> provides more detailed information about the <code>ProvisionedThroughputExceededException</code> exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis Developer Guide</i>. </para> <para> By default, data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream. This retention period can be modified using the <a>DecreaseStreamRetentionPeriod</a> and <a>IncreaseStreamRetentionPeriod</a> operations. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutRecords service method.</param> <returns>The response from the PutRecords service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.ProvisionedThroughputExceededException"> The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/api-retries.html" target="_blank">Error Retries and Exponential Backoff in AWS</a> in the <i>AWS General Reference</i>. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.PutRecordsAsync(Amazon.Kinesis.Model.PutRecordsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutRecords operation. </summary> <param name="request">Container for the necessary parameters to execute the PutRecords operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.RemoveTagsFromStream(Amazon.Kinesis.Model.RemoveTagsFromStreamRequest)"> <summary> Deletes tags from the specified Amazon Kinesis stream. <para> If you specify a tag that does not exist, it is ignored. </para> </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromStream service method.</param> <returns>The response from the RemoveTagsFromStream service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.RemoveTagsFromStreamAsync(Amazon.Kinesis.Model.RemoveTagsFromStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTagsFromStream operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.SplitShard(Amazon.Kinesis.Model.SplitShardRequest)"> <summary> Splits a shard into two new shards in the stream, to increase the stream's capacity to ingest and transport data. <code>SplitShard</code> is called when there is a need to increase the overall capacity of stream because of an expected increase in the volume of data records being ingested. <para> You can also use <code>SplitShard</code> when a shard appears to be approaching its maximum utilization, for example, when the set of producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call <code>SplitShard</code> to increase stream capacity, so that more Amazon Kinesis applications can simultaneously read data from the stream for real-time processing. </para> <para> You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might simply be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information about splitting shards, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html">Split a Shard</a> in the <i>Amazon Kinesis Developer Guide</i>. </para> <para> You can use <a>DescribeStream</a> to determine the shard ID and hash key values for the <code>ShardToSplit</code> and <code>NewStartingHashKey</code> parameters that are specified in the <code>SplitShard</code> request. </para> <para> <code>SplitShard</code> is an asynchronous operation. Upon receiving a <code>SplitShard</code> request, Amazon Kinesis immediately returns a response and sets the stream status to <code>UPDATING</code>. After the operation is completed, Amazon Kinesis sets the stream status to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </para> <para> You can use <code>DescribeStream</code> to check the status of the stream, which is returned in <code>StreamStatus</code>. If the stream is in the <code>ACTIVE</code> state, you can call <code>SplitShard</code>. If a stream is in <code>CREATING</code> or <code>UPDATING</code> or <code>DELETING</code> states, <code>DescribeStream</code> returns a <code>ResourceInUseException</code>. </para> <para> If the specified stream does not exist, <code>DescribeStream</code> returns a <code>ResourceNotFoundException</code>. If you try to create more shards than are authorized for your account, you receive a <code>LimitExceededException</code>. </para> <para> For the default shard limit for an AWS account, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Amazon Kinesis Limits</a>. If you need to increase this limit, <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">contact AWS Support</a>. </para> <para> If you try to operate on too many streams in parallel using <a>CreateStream</a>, <a>DeleteStream</a>, <a>MergeShards</a> or <a>SplitShard</a>, you receive a <code>LimitExceededException</code>. </para> <para> <code>SplitShard</code> has limit of 5 transactions per second per account. </para> </summary> <param name="request">Container for the necessary parameters to execute the SplitShard service method.</param> <returns>The response from the SplitShard service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.IAmazonKinesis.SplitShardAsync(Amazon.Kinesis.Model.SplitShardRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SplitShard operation. </summary> <param name="request">Container for the necessary parameters to execute the SplitShard operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.#ctor"> <summary> Constructs AmazonKinesisClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonKinesisClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.#ctor(Amazon.Kinesis.AmazonKinesisConfig)"> <summary> Constructs AmazonKinesisClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonKinesisClient Configuration Object</param> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonKinesisClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonKinesisClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.Kinesis.AmazonKinesisConfig)"> <summary> Constructs AmazonKinesisClient with AWS Credentials and an AmazonKinesisClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonKinesisClient Configuration Object</param> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonKinesisClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonKinesisClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.#ctor(System.String,System.String,Amazon.Kinesis.AmazonKinesisConfig)"> <summary> Constructs AmazonKinesisClient with AWS Access Key ID, AWS Secret Key and an AmazonKinesisClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonKinesisClient Configuration Object</param> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonKinesisClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonKinesisClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.#ctor(System.String,System.String,System.String,Amazon.Kinesis.AmazonKinesisConfig)"> <summary> Constructs AmazonKinesisClient with AWS Access Key ID, AWS Secret Key and an AmazonKinesisClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonKinesisClient Configuration Object</param> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.AddTagsToStream(Amazon.Kinesis.Model.AddTagsToStreamRequest)"> <summary> Adds or updates tags for the specified Amazon Kinesis stream. Each stream can have up to 10 tags. <para> If tags have already been assigned to the stream, <code>AddTagsToStream</code> overwrites any existing tags that correspond to the specified tag keys. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToStream service method.</param> <returns>The response from the AddTagsToStream service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.AddTagsToStreamAsync(Amazon.Kinesis.Model.AddTagsToStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTagsToStream operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.CreateStream(Amazon.Kinesis.Model.CreateStreamRequest)"> <summary> Creates a Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or <i>producers</i>. Scale-out within an Amazon Kinesis stream is explicitly supported by means of shards, which are uniquely identified groups of data records in an Amazon Kinesis stream. <para> You specify and control the number of shards that a stream is composed of. Each shard can support reads up to 5 transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases. </para> <para> The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name. </para> <para> <code>CreateStream</code> is an asynchronous operation. Upon receiving a <code>CreateStream</code> request, Amazon Kinesis immediately returns and sets the stream status to <code>CREATING</code>. After the stream is created, Amazon Kinesis sets the stream status to <code>ACTIVE</code>. You should perform read and write operations only on an <code>ACTIVE</code> stream. </para> <para> You receive a <code>LimitExceededException</code> when making a <code>CreateStream</code> request if you try to do one of the following: </para> <ul> <li>Have more than five streams in the <code>CREATING</code> state at any point in time.</li> <li>Create more shards than are authorized for your account.</li> </ul> <para> For the default shard limit for an AWS account, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Amazon Kinesis Limits</a>. If you need to increase this limit, <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">contact AWS Support</a>. </para> <para> You can use <code>DescribeStream</code> to check the stream status, which is returned in <code>StreamStatus</code>. </para> <para> <a>CreateStream</a> has a limit of 5 transactions per second per account. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateStream service method.</param> <returns>The response from the CreateStream service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.CreateStreamAsync(Amazon.Kinesis.Model.CreateStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateStream operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.DecreaseStreamRetentionPeriod(System.String,System.Int32)"> <summary> Decreases the stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream’s retention period is 24 hours. <para> This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible. </para> </summary> <param name="streamName">The name of the stream to modify.</param> <param name="retentionPeriodHours">The new retention period of the stream, in hours. Must be less than the current retention period.</param> <returns>The response from the DecreaseStreamRetentionPeriod service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.DecreaseStreamRetentionPeriod(Amazon.Kinesis.Model.DecreaseStreamRetentionPeriodRequest)"> <summary> Decreases the stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream’s retention period is 24 hours. <para> This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible. </para> </summary> <param name="request">Container for the necessary parameters to execute the DecreaseStreamRetentionPeriod service method.</param> <returns>The response from the DecreaseStreamRetentionPeriod service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.DecreaseStreamRetentionPeriodAsync(Amazon.Kinesis.Model.DecreaseStreamRetentionPeriodRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DecreaseStreamRetentionPeriod operation. </summary> <param name="request">Container for the necessary parameters to execute the DecreaseStreamRetentionPeriod operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.DeleteStream(Amazon.Kinesis.Model.DeleteStreamRequest)"> <summary> Deletes a stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it will receive the exception <code>ResourceNotFoundException</code>. <para> If the stream is in the <code>ACTIVE</code> state, you can delete it. After a <code>DeleteStream</code> request, the specified stream is in the <code>DELETING</code> state until Amazon Kinesis completes the deletion. </para> <para> <b>Note:</b> Amazon Kinesis might continue to accept data read and write operations, such as <a>PutRecord</a>, <a>PutRecords</a>, and <a>GetRecords</a>, on a stream in the <code>DELETING</code> state until the stream deletion is complete. </para> <para> When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream. </para> <para> You can use the <a>DescribeStream</a> operation to check the state of the stream, which is returned in <code>StreamStatus</code>. </para> <para> <a>DeleteStream</a> has a limit of 5 transactions per second per account. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteStream service method.</param> <returns>The response from the DeleteStream service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.DeleteStreamAsync(Amazon.Kinesis.Model.DeleteStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteStream operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.DescribeStream(Amazon.Kinesis.Model.DescribeStreamRequest)"> <summary> Describes the specified stream. <para> The information about the stream includes its current status, its Amazon Resource Name (ARN), and an array of shard objects. For each shard object, there is information about the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream. </para> <para> You can limit the number of returned shards using the <code>Limit</code> parameter. The number of shards in a stream may be too large to return from a single call to <code>DescribeStream</code>. You can detect this by using the <code>HasMoreShards</code> flag in the returned output. <code>HasMoreShards</code> is set to <code>true</code> when there is more data available. </para> <para> <code>DescribeStream</code> is a paginated operation. If there are more shards available, you can request them using the shard ID of the last shard returned. Specify this ID in the <code>ExclusiveStartShardId</code> parameter in a subsequent request to <code>DescribeStream</code>. </para> <para> <a>DescribeStream</a> has a limit of 10 transactions per second per account. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStream service method.</param> <returns>The response from the DescribeStream service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.DescribeStreamAsync(Amazon.Kinesis.Model.DescribeStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStream operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.GetRecords(Amazon.Kinesis.Model.GetRecordsRequest)"> <summary> Gets data records from a shard. <para> Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, <a>GetRecords</a> returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains records. </para> <para> You can scale by provisioning multiple shards. Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call <a>GetRecords</a> in a loop. Use <a>GetShardIterator</a> to get the shard iterator to specify in the first <a>GetRecords</a> call. <a>GetRecords</a> returns a new shard iterator in <code>NextShardIterator</code>. Specify the shard iterator returned in <code>NextShardIterator</code> in subsequent calls to <a>GetRecords</a>. Note that if the shard has been closed, the shard iterator can't return more data and <a>GetRecords</a> returns <code>null</code> in <code>NextShardIterator</code>. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process. </para> <para> Each data record can be up to 1 MB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the <code>Limit</code> parameter to specify the maximum number of records that <a>GetRecords</a> can return. Consider your average record size when determining this limit. </para> <para> The size of the data returned by <a>GetRecords</a> will vary depending on the utilization of the shard. The maximum size of data that <a>GetRecords</a> can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw <code>ProvisionedThroughputExceededException</code>. If there is insufficient provisioned throughput on the shard, subsequent calls made within the next 1 second throw <code>ProvisionedThroughputExceededException</code>. Note that <a>GetRecords</a> won't return any data when it throws an exception. For this reason, we recommend that you wait one second between calls to <a>GetRecords</a>; however, it's possible that the application will get exceptions for longer than 1 second. </para> <para> To detect whether the application is falling behind in processing, you can use the <code>MillisBehindLatest</code> response attribute. You can also monitor the stream using CloudWatch metrics (see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html">Monitoring Amazon Kinesis</a> in the <i>Amazon Kinesis Developer Guide</i>). </para> <para> Each Amazon Kinesis record includes a value, <code>ApproximateArrivalTimestamp</code>, that is set when an Amazon Kinesis stream successfully receives and stores a record. This is commonly referred to as a server-side timestamp, which is different than a client-side timestamp, where the timestamp is set when a data producer creates or sends the record to a stream. The timestamp has millisecond precision. There are no guarantees about the timestamp accuracy, or that the timestamp is always increasing. For example, records in a shard or across a stream might have timestamps that are out of order. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetRecords service method.</param> <returns>The response from the GetRecords service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.ExpiredIteratorException"> The provided iterator exceeds the maximum age allowed. </exception> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.ProvisionedThroughputExceededException"> The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/api-retries.html" target="_blank">Error Retries and Exponential Backoff in AWS</a> in the <i>AWS General Reference</i>. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.GetRecordsAsync(Amazon.Kinesis.Model.GetRecordsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetRecords operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRecords operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.GetShardIterator(Amazon.Kinesis.Model.GetShardIteratorRequest)"> <summary> Gets a shard iterator. A shard iterator expires five minutes after it is returned to the requester. <para> A shard iterator specifies the position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream. </para> <para> You must specify the shard iterator type. For example, you can set the <code>ShardIteratorType</code> parameter to read exactly from the position denoted by a specific sequence number by using the <code>AT_SEQUENCE_NUMBER</code> shard iterator type, or right after the sequence number by using the <code>AFTER_SEQUENCE_NUMBER</code> shard iterator type, using sequence numbers returned by earlier calls to <a>PutRecord</a>, <a>PutRecords</a>, <a>GetRecords</a>, or <a>DescribeStream</a>. You can specify the shard iterator type <code>TRIM_HORIZON</code> in the request to cause <code>ShardIterator</code> to point to the last untrimmed record in the shard in the system, which is the oldest data record in the shard. Or you can point to just after the most recent record in the shard, by using the shard iterator type <code>LATEST</code>, so that you always read the most recent data in the shard. </para> <para> When you repeatedly read from an Amazon Kinesis stream use a <a>GetShardIterator</a> request to get the first shard iterator for use in your first <a>GetRecords</a> request and then use the shard iterator returned by the <a>GetRecords</a> request in <code>NextShardIterator</code> for subsequent reads. A new shard iterator is returned by every <a>GetRecords</a> request in <code>NextShardIterator</code>, which you use in the <code>ShardIterator</code> parameter of the next <a>GetRecords</a> request. </para> <para> If a <a>GetShardIterator</a> request is made too often, you receive a <code>ProvisionedThroughputExceededException</code>. For more information about throughput limits, see <a>GetRecords</a>. </para> <para> If the shard is closed, the iterator can't return more data, and <a>GetShardIterator</a> returns <code>null</code> for its <code>ShardIterator</code>. A shard can be closed using <a>SplitShard</a> or <a>MergeShards</a>. </para> <para> <a>GetShardIterator</a> has a limit of 5 transactions per second per account per open shard. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetShardIterator service method.</param> <returns>The response from the GetShardIterator service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.ProvisionedThroughputExceededException"> The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/api-retries.html" target="_blank">Error Retries and Exponential Backoff in AWS</a> in the <i>AWS General Reference</i>. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.GetShardIteratorAsync(Amazon.Kinesis.Model.GetShardIteratorRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetShardIterator operation. </summary> <param name="request">Container for the necessary parameters to execute the GetShardIterator operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.IncreaseStreamRetentionPeriod(System.String,System.Int32)"> <summary> Increases the stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream’s retention period is 168 hours (7 days). <para> Upon choosing a longer stream retention period, this operation will increase the time period records are accessible that have not yet expired. However, it will not make previous data that has expired (older than the stream’s previous retention period) accessible after the operation has been called. For example, if a stream’s retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours will remain inaccessible to consumer applications. </para> </summary> <param name="streamName">The name of the stream to modify.</param> <param name="retentionPeriodHours">The new retention period of the stream, in hours. Must be more than the current retention period.</param> <returns>The response from the IncreaseStreamRetentionPeriod service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.IncreaseStreamRetentionPeriod(Amazon.Kinesis.Model.IncreaseStreamRetentionPeriodRequest)"> <summary> Increases the stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream’s retention period is 168 hours (7 days). <para> Upon choosing a longer stream retention period, this operation will increase the time period records are accessible that have not yet expired. However, it will not make previous data that has expired (older than the stream’s previous retention period) accessible after the operation has been called. For example, if a stream’s retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours will remain inaccessible to consumer applications. </para> </summary> <param name="request">Container for the necessary parameters to execute the IncreaseStreamRetentionPeriod service method.</param> <returns>The response from the IncreaseStreamRetentionPeriod service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.IncreaseStreamRetentionPeriodAsync(Amazon.Kinesis.Model.IncreaseStreamRetentionPeriodRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the IncreaseStreamRetentionPeriod operation. </summary> <param name="request">Container for the necessary parameters to execute the IncreaseStreamRetentionPeriod operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.ListStreams"> <summary> Lists your streams. <para> The number of streams may be too large to return from a single call to <code>ListStreams</code>. You can limit the number of returned streams using the <code>Limit</code> parameter. If you do not specify a value for the <code>Limit</code> parameter, Amazon Kinesis uses the default limit, which is currently 10. </para> <para> You can detect if there are more streams available to list by using the <code>HasMoreStreams</code> flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the <code>ListStreams</code> request in the <code>ExclusiveStartStreamName</code> parameter in a subsequent request to <code>ListStreams</code>. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list. </para> <para> <a>ListStreams</a> has a limit of 5 transactions per second per account. </para> </summary> <returns>The response from the ListStreams service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.ListStreams(Amazon.Kinesis.Model.ListStreamsRequest)"> <summary> Lists your streams. <para> The number of streams may be too large to return from a single call to <code>ListStreams</code>. You can limit the number of returned streams using the <code>Limit</code> parameter. If you do not specify a value for the <code>Limit</code> parameter, Amazon Kinesis uses the default limit, which is currently 10. </para> <para> You can detect if there are more streams available to list by using the <code>HasMoreStreams</code> flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the <code>ListStreams</code> request in the <code>ExclusiveStartStreamName</code> parameter in a subsequent request to <code>ListStreams</code>. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list. </para> <para> <a>ListStreams</a> has a limit of 5 transactions per second per account. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListStreams service method.</param> <returns>The response from the ListStreams service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.ListStreamsAsync(Amazon.Kinesis.Model.ListStreamsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListStreams operation. </summary> <param name="request">Container for the necessary parameters to execute the ListStreams operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.ListTagsForStream(Amazon.Kinesis.Model.ListTagsForStreamRequest)"> <summary> Lists the tags for the specified Amazon Kinesis stream. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForStream service method.</param> <returns>The response from the ListTagsForStream service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.ListTagsForStreamAsync(Amazon.Kinesis.Model.ListTagsForStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTagsForStream operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.MergeShards(Amazon.Kinesis.Model.MergeShardsRequest)"> <summary> Merges two adjacent shards in a stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards. <para> <code>MergeShards</code> is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html">Merge Two Shards</a> in the <i>Amazon Kinesis Developer Guide</i>. </para> <para> If the stream is in the <code>ACTIVE</code> state, you can call <code>MergeShards</code>. If a stream is in the <code>CREATING</code>, <code>UPDATING</code>, or <code>DELETING</code> state, <code>MergeShards</code> returns a <code>ResourceInUseException</code>. If the specified stream does not exist, <code>MergeShards</code> returns a <code>ResourceNotFoundException</code>. </para> <para> You can use <a>DescribeStream</a> to check the state of the stream, which is returned in <code>StreamStatus</code>. </para> <para> <code>MergeShards</code> is an asynchronous operation. Upon receiving a <code>MergeShards</code> request, Amazon Kinesis immediately returns a response and sets the <code>StreamStatus</code> to <code>UPDATING</code>. After the operation is completed, Amazon Kinesis sets the <code>StreamStatus</code> to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </para> <para> You use <a>DescribeStream</a> to determine the shard IDs that are specified in the <code>MergeShards</code> request. </para> <para> If you try to operate on too many streams in parallel using <a>CreateStream</a>, <a>DeleteStream</a>, <code>MergeShards</code> or <a>SplitShard</a>, you will receive a <code>LimitExceededException</code>. </para> <para> <code>MergeShards</code> has limit of 5 transactions per second per account. </para> </summary> <param name="request">Container for the necessary parameters to execute the MergeShards service method.</param> <returns>The response from the MergeShards service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.MergeShardsAsync(Amazon.Kinesis.Model.MergeShardsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the MergeShards operation. </summary> <param name="request">Container for the necessary parameters to execute the MergeShards operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.PutRecord(Amazon.Kinesis.Model.PutRecordRequest)"> <summary> Writes a single data record from a producer into an Amazon Kinesis stream. Call <code>PutRecord</code> to send data from the producer into the Amazon Kinesis stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. <para> You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself. </para> <para> The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on. </para> <para> The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a data stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to. </para> <para> Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the <code>ExplicitHashKey</code> parameter. For more information, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream">Adding Data to a Stream</a> in the <i>Amazon Kinesis Developer Guide</i>. </para> <para> <code>PutRecord</code> returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record. </para> <para> Sequence numbers generally increase over time. To guarantee strictly increasing ordering, use the <code>SequenceNumberForOrdering</code> parameter. For more information, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream">Adding Data to a Stream</a> in the <i>Amazon Kinesis Developer Guide</i>. </para> <para> If a <code>PutRecord</code> request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, <code>PutRecord</code> throws <code>ProvisionedThroughputExceededException</code>. </para> <para> By default, data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream. This retention period can be modified using the <a>DecreaseStreamRetentionPeriod</a> and <a>IncreaseStreamRetentionPeriod</a> operations. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutRecord service method.</param> <returns>The response from the PutRecord service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.ProvisionedThroughputExceededException"> The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/api-retries.html" target="_blank">Error Retries and Exponential Backoff in AWS</a> in the <i>AWS General Reference</i>. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.PutRecordAsync(Amazon.Kinesis.Model.PutRecordRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutRecord operation. </summary> <param name="request">Container for the necessary parameters to execute the PutRecord operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.PutRecords(Amazon.Kinesis.Model.PutRecordsRequest)"> <summary> Writes multiple data records from a producer into an Amazon Kinesis stream in a single call (also referred to as a <code>PutRecords</code> request). Use this operation to send data from a data producer into the Amazon Kinesis stream for data ingestion and processing. <para> Each <code>PutRecords</code> request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. </para> <para> You must specify the name of the stream that captures, stores, and transports the data; and an array of request <code>Records</code>, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob. </para> <para> The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on. </para> <para> The partition key is used by Amazon Kinesis as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream">Adding Data to a Stream</a> in the <i>Amazon Kinesis Developer Guide</i>. </para> <para> Each record in the <code>Records</code> array may include an optional parameter, <code>ExplicitHashKey</code>, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis Developer Guide</i>. </para> <para> The <code>PutRecords</code> response includes an array of response <code>Records</code>. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response <code>Records</code> array always includes the same number of records as the request array. </para> <para> The response <code>Records</code> array includes both successfully and unsuccessfully processed records. Amazon Kinesis attempts to process all records in each <code>PutRecords</code> request. A single record failure does not stop the processing of subsequent records. </para> <para> A successfully-processed record includes <code>ShardId</code> and <code>SequenceNumber</code> values. The <code>ShardId</code> parameter identifies the shard in the stream where the record is stored. The <code>SequenceNumber</code> parameter is an identifier assigned to the put record, unique to all records in the stream. </para> <para> An unsuccessfully-processed record includes <code>ErrorCode</code> and <code>ErrorMessage</code> values. <code>ErrorCode</code> reflects the type of error and can be one of the following values: <code>ProvisionedThroughputExceededException</code> or <code>InternalFailure</code>. <code>ErrorMessage</code> provides more detailed information about the <code>ProvisionedThroughputExceededException</code> exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis Developer Guide</i>. </para> <para> By default, data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream. This retention period can be modified using the <a>DecreaseStreamRetentionPeriod</a> and <a>IncreaseStreamRetentionPeriod</a> operations. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutRecords service method.</param> <returns>The response from the PutRecords service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.ProvisionedThroughputExceededException"> The request rate is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/api-retries.html" target="_blank">Error Retries and Exponential Backoff in AWS</a> in the <i>AWS General Reference</i>. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.PutRecordsAsync(Amazon.Kinesis.Model.PutRecordsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutRecords operation. </summary> <param name="request">Container for the necessary parameters to execute the PutRecords operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.RemoveTagsFromStream(Amazon.Kinesis.Model.RemoveTagsFromStreamRequest)"> <summary> Deletes tags from the specified Amazon Kinesis stream. <para> If you specify a tag that does not exist, it is ignored. </para> </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromStream service method.</param> <returns>The response from the RemoveTagsFromStream service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.RemoveTagsFromStreamAsync(Amazon.Kinesis.Model.RemoveTagsFromStreamRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTagsFromStream operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromStream operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.SplitShard(Amazon.Kinesis.Model.SplitShardRequest)"> <summary> Splits a shard into two new shards in the stream, to increase the stream's capacity to ingest and transport data. <code>SplitShard</code> is called when there is a need to increase the overall capacity of stream because of an expected increase in the volume of data records being ingested. <para> You can also use <code>SplitShard</code> when a shard appears to be approaching its maximum utilization, for example, when the set of producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call <code>SplitShard</code> to increase stream capacity, so that more Amazon Kinesis applications can simultaneously read data from the stream for real-time processing. </para> <para> You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might simply be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information about splitting shards, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html">Split a Shard</a> in the <i>Amazon Kinesis Developer Guide</i>. </para> <para> You can use <a>DescribeStream</a> to determine the shard ID and hash key values for the <code>ShardToSplit</code> and <code>NewStartingHashKey</code> parameters that are specified in the <code>SplitShard</code> request. </para> <para> <code>SplitShard</code> is an asynchronous operation. Upon receiving a <code>SplitShard</code> request, Amazon Kinesis immediately returns a response and sets the stream status to <code>UPDATING</code>. After the operation is completed, Amazon Kinesis sets the stream status to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </para> <para> You can use <code>DescribeStream</code> to check the status of the stream, which is returned in <code>StreamStatus</code>. If the stream is in the <code>ACTIVE</code> state, you can call <code>SplitShard</code>. If a stream is in <code>CREATING</code> or <code>UPDATING</code> or <code>DELETING</code> states, <code>DescribeStream</code> returns a <code>ResourceInUseException</code>. </para> <para> If the specified stream does not exist, <code>DescribeStream</code> returns a <code>ResourceNotFoundException</code>. If you try to create more shards than are authorized for your account, you receive a <code>LimitExceededException</code>. </para> <para> For the default shard limit for an AWS account, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Amazon Kinesis Limits</a>. If you need to increase this limit, <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">contact AWS Support</a>. </para> <para> If you try to operate on too many streams in parallel using <a>CreateStream</a>, <a>DeleteStream</a>, <a>MergeShards</a> or <a>SplitShard</a>, you receive a <code>LimitExceededException</code>. </para> <para> <code>SplitShard</code> has limit of 5 transactions per second per account. </para> </summary> <param name="request">Container for the necessary parameters to execute the SplitShard service method.</param> <returns>The response from the SplitShard service method, as returned by Kinesis.</returns> <exception cref="T:Amazon.Kinesis.Model.InvalidArgumentException"> A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. </exception> <exception cref="T:Amazon.Kinesis.Model.LimitExceededException"> The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5). </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceInUseException"> The resource is not available for this operation. For successful operation, the resource needs to be in the <code>ACTIVE</code> state. </exception> <exception cref="T:Amazon.Kinesis.Model.ResourceNotFoundException"> The requested resource could not be found. The stream might not be specified correctly, or it might not be in the <code>ACTIVE</code> state if the operation requires it. </exception> </member> <member name="M:Amazon.Kinesis.AmazonKinesisClient.SplitShardAsync(Amazon.Kinesis.Model.SplitShardRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SplitShard operation. </summary> <param name="request">Container for the necessary parameters to execute the SplitShard operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.Lambda.AmazonLambdaClient"> <summary> Implementation for accessing Lambda AWS Lambda <para> <b>Overview</b> </para> <para> This is the <i>AWS Lambda API Reference</i>. The AWS Lambda Developer Guide provides additional information. For the service overview, go to <a href="http://docs.aws.amazon.com/lambda/latest/dg/welcome.html">What is AWS Lambda</a>, and for information about how the service works, go to <a href="http://docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html">AWS Lambda: How it Works</a> in the <i>AWS Lambda Developer Guide</i>. </para> </summary> </member> <member name="T:Amazon.Lambda.IAmazonLambda"> <summary> Interface for accessing Lambda AWS Lambda <para> <b>Overview</b> </para> <para> This is the <i>AWS Lambda API Reference</i>. The AWS Lambda Developer Guide provides additional information. For the service overview, go to <a href="http://docs.aws.amazon.com/lambda/latest/dg/welcome.html">What is AWS Lambda</a>, and for information about how the service works, go to <a href="http://docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html">AWS Lambda: How it Works</a> in the <i>AWS Lambda Developer Guide</i>. </para> </summary> <summary> Interface for accessing Lambda </summary> </member> <member name="M:Amazon.Lambda.IAmazonLambda.AddPermission(Amazon.Lambda.Model.AddPermissionRequest)"> <summary> Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use <i>push</i> model. In a <i>push</i> model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source, permission to invoke the Lambda function. <para> For information about the push model, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html">AWS Lambda: How it Works</a>. </para> <para> If you are using versioning, the permissions you add are specific to the Lambda function version or alias you specify in the <code>AddPermission</code> request via the <code>Qualifier</code> parameter. For more information about versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:AddPermission</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddPermission service method.</param> <returns>The response from the AddPermission service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.PolicyLengthExceededException"> Lambda function access policy is limited to 20 KB. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceConflictException"> The resource already exists. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.AddPermissionAsync(Amazon.Lambda.Model.AddPermissionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddPermission operation. </summary> <param name="request">Container for the necessary parameters to execute the AddPermission operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.CreateAlias(Amazon.Lambda.Model.CreateAliasRequest)"> <summary> Creates an alias that points to the specified Lambda function version. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html">Introduction to AWS Lambda Aliases</a>. Alias names are unique for a given function. <para> This requires permission for the lambda:CreateAlias action. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateAlias service method.</param> <returns>The response from the CreateAlias service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceConflictException"> The resource already exists. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.CreateAliasAsync(Amazon.Lambda.Model.CreateAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.CreateEventSourceMapping(Amazon.Lambda.Model.CreateEventSourceMappingRequest)"> <summary> Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream. <para> This association between a stream source and a Lambda function is called the event source mapping. </para> <important>This event source mapping is relevant only in the AWS Lambda pull model, where AWS Lambda invokes the function. For more information, go to <a href="http://docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html">AWS Lambda: How it Works</a> in the <i>AWS Lambda Developer Guide</i>.</important> <para> You provide mapping information (for example, which stream to read from and which Lambda function to invoke) in the request body. </para> <para> Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda function. A given Lambda function can be associated with multiple AWS event sources. </para> <para> <para> If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> </para> <para> This operation requires permission for the <code>lambda:CreateEventSourceMapping</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateEventSourceMapping service method.</param> <returns>The response from the CreateEventSourceMapping service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceConflictException"> The resource already exists. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.CreateEventSourceMappingAsync(Amazon.Lambda.Model.CreateEventSourceMappingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateEventSourceMapping operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateEventSourceMapping operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.CreateFunction(Amazon.Lambda.Model.CreateFunctionRequest)"> <summary> Creates a new Lambda function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the operation will fail. Note that the function name is case-sensitive. <para> If you are using versioning, you can also publish a version of the Lambda function you are creating using the <code>Publish</code> parameter. For more information about versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:CreateFunction</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateFunction service method.</param> <returns>The response from the CreateFunction service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.CodeStorageExceededException"> You have exceeded your maximum total code size per account. <a href="http://docs.aws.amazon.com/lambda/latest/dg/limits.html">Limits</a> </exception> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceConflictException"> The resource already exists. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.CreateFunctionAsync(Amazon.Lambda.Model.CreateFunctionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateFunction operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateFunction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.DeleteAlias(Amazon.Lambda.Model.DeleteAliasRequest)"> <summary> Deletes the specified Lambda function alias. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html">Introduction to AWS Lambda Aliases</a>. <para> This requires permission for the lambda:DeleteAlias action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAlias service method.</param> <returns>The response from the DeleteAlias service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.DeleteAliasAsync(Amazon.Lambda.Model.DeleteAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.DeleteEventSourceMapping(Amazon.Lambda.Model.DeleteEventSourceMappingRequest)"> <summary> Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source. <para> This operation requires permission for the <code>lambda:DeleteEventSourceMapping</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteEventSourceMapping service method.</param> <returns>The response from the DeleteEventSourceMapping service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.DeleteEventSourceMappingAsync(Amazon.Lambda.Model.DeleteEventSourceMappingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteEventSourceMapping operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEventSourceMapping operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.DeleteFunction(System.String)"> <summary> Deletes the specified Lambda function code and configuration. <para> If you are using the versioning feature and you don't specify a function version in your <code>DeleteFunction</code> request, AWS Lambda will delete the function, including all its versions, and any aliases pointing to the function versions. To delete a specific function version, you must provide the function version via the <code>Qualifier</code> parameter. For information about function versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> When you delete a function the associated resource policy is also deleted. You will need to delete the event source mappings explicitly. </para> <para> This operation requires permission for the <code>lambda:DeleteFunction</code> action. </para> </summary> <param name="functionName">The Lambda function to delete. You can specify the function name (for example, <code>Thumbnail</code>) or you can specify Amazon Resource Name (ARN) of the function (for example, <code>arn:aws:lambda:us-west-2:account-id:function:ThumbNail</code>). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, <code>account-id:Thumbnail</code>). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </param> <returns>The response from the DeleteFunction service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceConflictException"> The resource already exists. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.DeleteFunction(Amazon.Lambda.Model.DeleteFunctionRequest)"> <summary> Deletes the specified Lambda function code and configuration. <para> If you are using the versioning feature and you don't specify a function version in your <code>DeleteFunction</code> request, AWS Lambda will delete the function, including all its versions, and any aliases pointing to the function versions. To delete a specific function version, you must provide the function version via the <code>Qualifier</code> parameter. For information about function versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> When you delete a function the associated resource policy is also deleted. You will need to delete the event source mappings explicitly. </para> <para> This operation requires permission for the <code>lambda:DeleteFunction</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteFunction service method.</param> <returns>The response from the DeleteFunction service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceConflictException"> The resource already exists. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.DeleteFunctionAsync(Amazon.Lambda.Model.DeleteFunctionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteFunction operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteFunction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.GetAlias(Amazon.Lambda.Model.GetAliasRequest)"> <summary> Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html">Introduction to AWS Lambda Aliases</a>. <para> This requires permission for the <code>lambda:GetAlias</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetAlias service method.</param> <returns>The response from the GetAlias service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.GetAliasAsync(Amazon.Lambda.Model.GetAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the GetAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.GetEventSourceMapping(Amazon.Lambda.Model.GetEventSourceMappingRequest)"> <summary> Returns configuration information for the specified event source mapping (see <a>CreateEventSourceMapping</a>). <para> This operation requires permission for the <code>lambda:GetEventSourceMapping</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetEventSourceMapping service method.</param> <returns>The response from the GetEventSourceMapping service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.GetEventSourceMappingAsync(Amazon.Lambda.Model.GetEventSourceMappingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetEventSourceMapping operation. </summary> <param name="request">Container for the necessary parameters to execute the GetEventSourceMapping operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.GetFunction(System.String)"> <summary> Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with <a>CreateFunction</a> so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function. <para> Using the optional <code>Qualifier</code> parameter, you can specify a specific function version for which you want this information. If you don't specify this parameter, the API uses unqualified function ARN which return information about the <code>$LATEST</code> version of the Lambda function. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:GetFunction</code> action. </para> </summary> <param name="functionName">The Lambda function name. You can specify a function name (for example, <code>Thumbnail</code>) or you can specify Amazon Resource Name (ARN) of the function (for example, <code>arn:aws:lambda:us-west-2:account-id:function:ThumbNail</code>). AWS Lambda also allows you to specify a partial ARN (for example, <code>account-id:Thumbnail</code>). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </param> <returns>The response from the GetFunction service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.GetFunction(Amazon.Lambda.Model.GetFunctionRequest)"> <summary> Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with <a>CreateFunction</a> so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function. <para> Using the optional <code>Qualifier</code> parameter, you can specify a specific function version for which you want this information. If you don't specify this parameter, the API uses unqualified function ARN which return information about the <code>$LATEST</code> version of the Lambda function. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:GetFunction</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetFunction service method.</param> <returns>The response from the GetFunction service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.GetFunctionAsync(Amazon.Lambda.Model.GetFunctionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetFunction operation. </summary> <param name="request">Container for the necessary parameters to execute the GetFunction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.GetFunctionConfiguration(System.String)"> <summary> Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using <a>CreateFunction</a>. <para> If you are using the versioning feature, you can retrieve this information for a specific function version by using the optional <code>Qualifier</code> parameter and specifying the function version or alias that points to it. If you don't provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:GetFunctionConfiguration</code> operation. </para> </summary> <param name="functionName">The name of the Lambda function for which you want to retrieve the configuration information. You can specify a function name (for example, <code>Thumbnail</code>) or you can specify Amazon Resource Name (ARN) of the function (for example, <code>arn:aws:lambda:us-west-2:account-id:function:ThumbNail</code>). AWS Lambda also allows you to specify a partial ARN (for example, <code>account-id:Thumbnail</code>). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </param> <returns>The response from the GetFunctionConfiguration service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.GetFunctionConfiguration(Amazon.Lambda.Model.GetFunctionConfigurationRequest)"> <summary> Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using <a>CreateFunction</a>. <para> If you are using the versioning feature, you can retrieve this information for a specific function version by using the optional <code>Qualifier</code> parameter and specifying the function version or alias that points to it. If you don't provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:GetFunctionConfiguration</code> operation. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetFunctionConfiguration service method.</param> <returns>The response from the GetFunctionConfiguration service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.GetFunctionConfigurationAsync(Amazon.Lambda.Model.GetFunctionConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetFunctionConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the GetFunctionConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.GetPolicy(Amazon.Lambda.Model.GetPolicyRequest)"> <summary> Returns the resource policy associated with the specified Lambda function. <para> If you are using the versioning feature, you can get the resource policy associated with the specific Lambda function version or alias by specifying the version or alias name using the <code>Qualifier</code> parameter. For more information about versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> For information about adding permissions, see <a>AddPermission</a>. </para> <para> You need permission for the <code>lambda:GetPolicy action.</code> </para> </summary> <param name="request">Container for the necessary parameters to execute the GetPolicy service method.</param> <returns>The response from the GetPolicy service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.GetPolicyAsync(Amazon.Lambda.Model.GetPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.Invoke(Amazon.Lambda.Model.InvokeRequest)"> <summary> Invokes a specific Lambda function. <para> If you are using the versioning feature, you can invoke the specific function version by providing function version or alias name that is pointing to the function version using the <code>Qualifier</code> parameter in the request. If you don't provide the <code>Qualifier</code> parameter, the <code>$LATEST</code> version of the Lambda function is invoked. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:InvokeFunction</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the Invoke service method.</param> <returns>The response from the Invoke service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.EC2AccessDeniedException"> </exception> <exception cref="T:Amazon.Lambda.Model.EC2ThrottledException"> AWS Lambda was throttled by Amazon EC2 during Lambda function initiatization using the execution role provided for the Lambda function. </exception> <exception cref="T:Amazon.Lambda.Model.EC2UnexpectedException"> AWS Lambda received an unexpected EC2 client exception while setting up for the Lambda function. </exception> <exception cref="T:Amazon.Lambda.Model.ENILimitReachedException"> AWS Lambda was not able to create an Elastic Network Interface (ENI) in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached. </exception> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.InvalidRequestContentException"> The request body could not be parsed as JSON. </exception> <exception cref="T:Amazon.Lambda.Model.InvalidSecurityGroupIDException"> The Security Group ID provided in the Lambda function VPC configuration is invalid. </exception> <exception cref="T:Amazon.Lambda.Model.InvalidSubnetIDException"> The Subnet ID provided in the Lambda function VPC configuration is invalid. </exception> <exception cref="T:Amazon.Lambda.Model.RequestTooLargeException"> The request payload exceeded the <code>Invoke</code> request body JSON input limit. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/limits.html">Limits</a>. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.SubnetIPAddressLimitReachedException"> AWS Lambda was not able to set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> <exception cref="T:Amazon.Lambda.Model.UnsupportedMediaTypeException"> The content type of the <code>Invoke</code> request body is not JSON. </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.InvokeAsync(Amazon.Lambda.Model.InvokeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Invoke operation. </summary> <param name="request">Container for the necessary parameters to execute the Invoke operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.InvokeAsync(Amazon.Lambda.Model.InvokeAsyncRequest)"> <summary> <important>This API is deprecated. We recommend you use <code>Invoke</code> API (see <a>Invoke</a>).</important> <para> Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch Logs console. </para> <para> This operation requires permission for the <code>lambda:InvokeFunction</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the InvokeAsync service method.</param> <returns>The response from the InvokeAsync service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidRequestContentException"> The request body could not be parsed as JSON. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.InvokeAsyncAsync(Amazon.Lambda.Model.InvokeAsyncRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the InvokeAsync operation. </summary> <param name="request">Container for the necessary parameters to execute the InvokeAsync operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.ListAliases(Amazon.Lambda.Model.ListAliasesRequest)"> <summary> Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html">Introduction to AWS Lambda Aliases</a>. <para> This requires permission for the lambda:ListAliases action. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListAliases service method.</param> <returns>The response from the ListAliases service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.ListAliasesAsync(Amazon.Lambda.Model.ListAliasesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAliases operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAliases operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.ListEventSourceMappings(Amazon.Lambda.Model.ListEventSourceMappingsRequest)"> <summary> Returns a list of event source mappings you created using the <code>CreateEventSourceMapping</code> (see <a>CreateEventSourceMapping</a>). <para> For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings. </para> <para> If you are using the versioning feature, you can get list of event source mappings for a specific Lambda function version or an alias as described in the <code>FunctionName</code> parameter. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:ListEventSourceMappings</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListEventSourceMappings service method.</param> <returns>The response from the ListEventSourceMappings service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.ListEventSourceMappingsAsync(Amazon.Lambda.Model.ListEventSourceMappingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListEventSourceMappings operation. </summary> <param name="request">Container for the necessary parameters to execute the ListEventSourceMappings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.ListFunctions"> <summary> Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use <a>GetFunction</a> to retrieve the code for your function. <para> This operation requires permission for the <code>lambda:ListFunctions</code> action. </para> <para> If you are using versioning feature, the response returns list of $LATEST versions of your functions. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> </summary> <returns>The response from the ListFunctions service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.ListFunctions(Amazon.Lambda.Model.ListFunctionsRequest)"> <summary> Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use <a>GetFunction</a> to retrieve the code for your function. <para> This operation requires permission for the <code>lambda:ListFunctions</code> action. </para> <para> If you are using versioning feature, the response returns list of $LATEST versions of your functions. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListFunctions service method.</param> <returns>The response from the ListFunctions service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.ListFunctionsAsync(Amazon.Lambda.Model.ListFunctionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListFunctions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListFunctions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.ListVersionsByFunction(Amazon.Lambda.Model.ListVersionsByFunctionRequest)"> <summary> List all versions of a function. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </summary> <param name="request">Container for the necessary parameters to execute the ListVersionsByFunction service method.</param> <returns>The response from the ListVersionsByFunction service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.ListVersionsByFunctionAsync(Amazon.Lambda.Model.ListVersionsByFunctionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListVersionsByFunction operation. </summary> <param name="request">Container for the necessary parameters to execute the ListVersionsByFunction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.PublishVersion(Amazon.Lambda.Model.PublishVersionRequest)"> <summary> Publishes a version of your function from the current snapshot of $LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from $LATEST and publishes a new version. The code and configuration cannot be modified after publication. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </summary> <param name="request">Container for the necessary parameters to execute the PublishVersion service method.</param> <returns>The response from the PublishVersion service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.CodeStorageExceededException"> You have exceeded your maximum total code size per account. <a href="http://docs.aws.amazon.com/lambda/latest/dg/limits.html">Limits</a> </exception> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.PublishVersionAsync(Amazon.Lambda.Model.PublishVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PublishVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the PublishVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.RemovePermission(Amazon.Lambda.Model.RemovePermissionRequest)"> <summary> You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission. <para> If you are using versioning, the permissions you remove are specific to the Lambda function version or alias you specify in the <code>AddPermission</code> request via the <code>Qualifier</code> parameter. For more information about versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> Note that removal of a permission will cause an active event source to lose permission to the function. </para> <para> You need permission for the <code>lambda:RemovePermission</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the RemovePermission service method.</param> <returns>The response from the RemovePermission service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.RemovePermissionAsync(Amazon.Lambda.Model.RemovePermissionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemovePermission operation. </summary> <param name="request">Container for the necessary parameters to execute the RemovePermission operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.UpdateAlias(Amazon.Lambda.Model.UpdateAliasRequest)"> <summary> Using this API you can update the function version to which the alias points and the alias description. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html">Introduction to AWS Lambda Aliases</a>. <para> This requires permission for the lambda:UpdateAlias action. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAlias service method.</param> <returns>The response from the UpdateAlias service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.UpdateAliasAsync(Amazon.Lambda.Model.UpdateAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.UpdateEventSourceMapping(Amazon.Lambda.Model.UpdateEventSourceMappingRequest)"> <summary> You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping. <para> If you are using the versioning feature, you can update the event source mapping to map to a specific Lambda function version or alias as described in the <code>FunctionName</code> parameter. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> If you disable the event source mapping, AWS Lambda stops polling. If you enable again, it will resume polling from the time it had stopped polling, so you don't lose processing of any records. However, if you delete event source mapping and create it again, it will reset. </para> <para> This operation requires permission for the <code>lambda:UpdateEventSourceMapping</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateEventSourceMapping service method.</param> <returns>The response from the UpdateEventSourceMapping service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceConflictException"> The resource already exists. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.UpdateEventSourceMappingAsync(Amazon.Lambda.Model.UpdateEventSourceMappingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateEventSourceMapping operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateEventSourceMapping operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.UpdateFunctionCode(Amazon.Lambda.Model.UpdateFunctionCodeRequest)"> <summary> Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration. <para> If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:UpdateFunctionCode</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateFunctionCode service method.</param> <returns>The response from the UpdateFunctionCode service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.CodeStorageExceededException"> You have exceeded your maximum total code size per account. <a href="http://docs.aws.amazon.com/lambda/latest/dg/limits.html">Limits</a> </exception> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.UpdateFunctionCodeAsync(Amazon.Lambda.Model.UpdateFunctionCodeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateFunctionCode operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateFunctionCode operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.UpdateFunctionConfiguration(Amazon.Lambda.Model.UpdateFunctionConfigurationRequest)"> <summary> Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code. <para> If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:UpdateFunctionConfiguration</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateFunctionConfiguration service method.</param> <returns>The response from the UpdateFunctionConfiguration service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.IAmazonLambda.UpdateFunctionConfigurationAsync(Amazon.Lambda.Model.UpdateFunctionConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateFunctionConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateFunctionConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.IAmazonLambda.InvokeAsync(System.String)"> <summary> Submits an invocation request to Lambda. Upon receiving the request, Lambda executes the specified cloud function asynchronously. To see the logs generated by the cloud function execution, see the CloudWatch logs console. <para> This operation requires permission for the <code>lambda:InvokeAsync</code> action. </para> <para> The InvokeArgs will be set to an empty json document. </para> </summary> <param name="functionName">The cloud function to invoke.</param> <returns>The response from the InvokeAsync service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidRequestContentException"/> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Lambda.Model.ServiceException"/> </member> <member name="M:Amazon.Lambda.IAmazonLambda.InvokeAsync(System.String,System.String)"> <summary> Submits an invocation request to Lambda. Upon receiving the request, Lambda executes the specified cloud function asynchronously. To see the logs generated by the cloud function execution, see the CloudWatch logs console. <para> This operation requires permission for the <code>lambda:InvokeAsync</code> action. </para> </summary> <param name="functionName">The cloud function to invoke.</param> <param name="invokeArgs">A Json document that will be passed to the cloud function.</param> <returns>The response from the InvokeAsync service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidRequestContentException"/> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Lambda.Model.ServiceException"/> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.#ctor"> <summary> Constructs AmazonLambdaClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonLambdaClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.#ctor(Amazon.Lambda.AmazonLambdaConfig)"> <summary> Constructs AmazonLambdaClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonLambdaClient Configuration Object</param> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonLambdaClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonLambdaClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.Lambda.AmazonLambdaConfig)"> <summary> Constructs AmazonLambdaClient with AWS Credentials and an AmazonLambdaClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonLambdaClient Configuration Object</param> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonLambdaClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonLambdaClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.#ctor(System.String,System.String,Amazon.Lambda.AmazonLambdaConfig)"> <summary> Constructs AmazonLambdaClient with AWS Access Key ID, AWS Secret Key and an AmazonLambdaClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonLambdaClient Configuration Object</param> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonLambdaClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonLambdaClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.#ctor(System.String,System.String,System.String,Amazon.Lambda.AmazonLambdaConfig)"> <summary> Constructs AmazonLambdaClient with AWS Access Key ID, AWS Secret Key and an AmazonLambdaClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonLambdaClient Configuration Object</param> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.AddPermission(Amazon.Lambda.Model.AddPermissionRequest)"> <summary> Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use <i>push</i> model. In a <i>push</i> model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source, permission to invoke the Lambda function. <para> For information about the push model, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html">AWS Lambda: How it Works</a>. </para> <para> If you are using versioning, the permissions you add are specific to the Lambda function version or alias you specify in the <code>AddPermission</code> request via the <code>Qualifier</code> parameter. For more information about versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:AddPermission</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddPermission service method.</param> <returns>The response from the AddPermission service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.PolicyLengthExceededException"> Lambda function access policy is limited to 20 KB. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceConflictException"> The resource already exists. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.AddPermissionAsync(Amazon.Lambda.Model.AddPermissionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddPermission operation. </summary> <param name="request">Container for the necessary parameters to execute the AddPermission operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.CreateAlias(Amazon.Lambda.Model.CreateAliasRequest)"> <summary> Creates an alias that points to the specified Lambda function version. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html">Introduction to AWS Lambda Aliases</a>. Alias names are unique for a given function. <para> This requires permission for the lambda:CreateAlias action. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateAlias service method.</param> <returns>The response from the CreateAlias service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceConflictException"> The resource already exists. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.CreateAliasAsync(Amazon.Lambda.Model.CreateAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.CreateEventSourceMapping(Amazon.Lambda.Model.CreateEventSourceMappingRequest)"> <summary> Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream. <para> This association between a stream source and a Lambda function is called the event source mapping. </para> <important>This event source mapping is relevant only in the AWS Lambda pull model, where AWS Lambda invokes the function. For more information, go to <a href="http://docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html">AWS Lambda: How it Works</a> in the <i>AWS Lambda Developer Guide</i>.</important> <para> You provide mapping information (for example, which stream to read from and which Lambda function to invoke) in the request body. </para> <para> Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda function. A given Lambda function can be associated with multiple AWS event sources. </para> <para> <para> If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> </para> <para> This operation requires permission for the <code>lambda:CreateEventSourceMapping</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateEventSourceMapping service method.</param> <returns>The response from the CreateEventSourceMapping service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceConflictException"> The resource already exists. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.CreateEventSourceMappingAsync(Amazon.Lambda.Model.CreateEventSourceMappingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateEventSourceMapping operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateEventSourceMapping operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.CreateFunction(Amazon.Lambda.Model.CreateFunctionRequest)"> <summary> Creates a new Lambda function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the operation will fail. Note that the function name is case-sensitive. <para> If you are using versioning, you can also publish a version of the Lambda function you are creating using the <code>Publish</code> parameter. For more information about versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:CreateFunction</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateFunction service method.</param> <returns>The response from the CreateFunction service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.CodeStorageExceededException"> You have exceeded your maximum total code size per account. <a href="http://docs.aws.amazon.com/lambda/latest/dg/limits.html">Limits</a> </exception> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceConflictException"> The resource already exists. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.CreateFunctionAsync(Amazon.Lambda.Model.CreateFunctionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateFunction operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateFunction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.DeleteAlias(Amazon.Lambda.Model.DeleteAliasRequest)"> <summary> Deletes the specified Lambda function alias. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html">Introduction to AWS Lambda Aliases</a>. <para> This requires permission for the lambda:DeleteAlias action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAlias service method.</param> <returns>The response from the DeleteAlias service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.DeleteAliasAsync(Amazon.Lambda.Model.DeleteAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.DeleteEventSourceMapping(Amazon.Lambda.Model.DeleteEventSourceMappingRequest)"> <summary> Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source. <para> This operation requires permission for the <code>lambda:DeleteEventSourceMapping</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteEventSourceMapping service method.</param> <returns>The response from the DeleteEventSourceMapping service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.DeleteEventSourceMappingAsync(Amazon.Lambda.Model.DeleteEventSourceMappingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteEventSourceMapping operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEventSourceMapping operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.DeleteFunction(System.String)"> <summary> Deletes the specified Lambda function code and configuration. <para> If you are using the versioning feature and you don't specify a function version in your <code>DeleteFunction</code> request, AWS Lambda will delete the function, including all its versions, and any aliases pointing to the function versions. To delete a specific function version, you must provide the function version via the <code>Qualifier</code> parameter. For information about function versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> When you delete a function the associated resource policy is also deleted. You will need to delete the event source mappings explicitly. </para> <para> This operation requires permission for the <code>lambda:DeleteFunction</code> action. </para> </summary> <param name="functionName">The Lambda function to delete. You can specify the function name (for example, <code>Thumbnail</code>) or you can specify Amazon Resource Name (ARN) of the function (for example, <code>arn:aws:lambda:us-west-2:account-id:function:ThumbNail</code>). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, <code>account-id:Thumbnail</code>). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </param> <returns>The response from the DeleteFunction service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceConflictException"> The resource already exists. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.DeleteFunction(Amazon.Lambda.Model.DeleteFunctionRequest)"> <summary> Deletes the specified Lambda function code and configuration. <para> If you are using the versioning feature and you don't specify a function version in your <code>DeleteFunction</code> request, AWS Lambda will delete the function, including all its versions, and any aliases pointing to the function versions. To delete a specific function version, you must provide the function version via the <code>Qualifier</code> parameter. For information about function versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> When you delete a function the associated resource policy is also deleted. You will need to delete the event source mappings explicitly. </para> <para> This operation requires permission for the <code>lambda:DeleteFunction</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteFunction service method.</param> <returns>The response from the DeleteFunction service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceConflictException"> The resource already exists. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.DeleteFunctionAsync(Amazon.Lambda.Model.DeleteFunctionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteFunction operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteFunction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.GetAlias(Amazon.Lambda.Model.GetAliasRequest)"> <summary> Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html">Introduction to AWS Lambda Aliases</a>. <para> This requires permission for the <code>lambda:GetAlias</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetAlias service method.</param> <returns>The response from the GetAlias service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.GetAliasAsync(Amazon.Lambda.Model.GetAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the GetAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.GetEventSourceMapping(Amazon.Lambda.Model.GetEventSourceMappingRequest)"> <summary> Returns configuration information for the specified event source mapping (see <a>CreateEventSourceMapping</a>). <para> This operation requires permission for the <code>lambda:GetEventSourceMapping</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetEventSourceMapping service method.</param> <returns>The response from the GetEventSourceMapping service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.GetEventSourceMappingAsync(Amazon.Lambda.Model.GetEventSourceMappingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetEventSourceMapping operation. </summary> <param name="request">Container for the necessary parameters to execute the GetEventSourceMapping operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.GetFunction(System.String)"> <summary> Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with <a>CreateFunction</a> so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function. <para> Using the optional <code>Qualifier</code> parameter, you can specify a specific function version for which you want this information. If you don't specify this parameter, the API uses unqualified function ARN which return information about the <code>$LATEST</code> version of the Lambda function. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:GetFunction</code> action. </para> </summary> <param name="functionName">The Lambda function name. You can specify a function name (for example, <code>Thumbnail</code>) or you can specify Amazon Resource Name (ARN) of the function (for example, <code>arn:aws:lambda:us-west-2:account-id:function:ThumbNail</code>). AWS Lambda also allows you to specify a partial ARN (for example, <code>account-id:Thumbnail</code>). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </param> <returns>The response from the GetFunction service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.GetFunction(Amazon.Lambda.Model.GetFunctionRequest)"> <summary> Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with <a>CreateFunction</a> so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function. <para> Using the optional <code>Qualifier</code> parameter, you can specify a specific function version for which you want this information. If you don't specify this parameter, the API uses unqualified function ARN which return information about the <code>$LATEST</code> version of the Lambda function. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:GetFunction</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetFunction service method.</param> <returns>The response from the GetFunction service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.GetFunctionAsync(Amazon.Lambda.Model.GetFunctionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetFunction operation. </summary> <param name="request">Container for the necessary parameters to execute the GetFunction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.GetFunctionConfiguration(System.String)"> <summary> Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using <a>CreateFunction</a>. <para> If you are using the versioning feature, you can retrieve this information for a specific function version by using the optional <code>Qualifier</code> parameter and specifying the function version or alias that points to it. If you don't provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:GetFunctionConfiguration</code> operation. </para> </summary> <param name="functionName">The name of the Lambda function for which you want to retrieve the configuration information. You can specify a function name (for example, <code>Thumbnail</code>) or you can specify Amazon Resource Name (ARN) of the function (for example, <code>arn:aws:lambda:us-west-2:account-id:function:ThumbNail</code>). AWS Lambda also allows you to specify a partial ARN (for example, <code>account-id:Thumbnail</code>). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </param> <returns>The response from the GetFunctionConfiguration service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.GetFunctionConfiguration(Amazon.Lambda.Model.GetFunctionConfigurationRequest)"> <summary> Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using <a>CreateFunction</a>. <para> If you are using the versioning feature, you can retrieve this information for a specific function version by using the optional <code>Qualifier</code> parameter and specifying the function version or alias that points to it. If you don't provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:GetFunctionConfiguration</code> operation. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetFunctionConfiguration service method.</param> <returns>The response from the GetFunctionConfiguration service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.GetFunctionConfigurationAsync(Amazon.Lambda.Model.GetFunctionConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetFunctionConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the GetFunctionConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.GetPolicy(Amazon.Lambda.Model.GetPolicyRequest)"> <summary> Returns the resource policy associated with the specified Lambda function. <para> If you are using the versioning feature, you can get the resource policy associated with the specific Lambda function version or alias by specifying the version or alias name using the <code>Qualifier</code> parameter. For more information about versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> For information about adding permissions, see <a>AddPermission</a>. </para> <para> You need permission for the <code>lambda:GetPolicy action.</code> </para> </summary> <param name="request">Container for the necessary parameters to execute the GetPolicy service method.</param> <returns>The response from the GetPolicy service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.GetPolicyAsync(Amazon.Lambda.Model.GetPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.Invoke(Amazon.Lambda.Model.InvokeRequest)"> <summary> Invokes a specific Lambda function. <para> If you are using the versioning feature, you can invoke the specific function version by providing function version or alias name that is pointing to the function version using the <code>Qualifier</code> parameter in the request. If you don't provide the <code>Qualifier</code> parameter, the <code>$LATEST</code> version of the Lambda function is invoked. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:InvokeFunction</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the Invoke service method.</param> <returns>The response from the Invoke service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.EC2AccessDeniedException"> </exception> <exception cref="T:Amazon.Lambda.Model.EC2ThrottledException"> AWS Lambda was throttled by Amazon EC2 during Lambda function initiatization using the execution role provided for the Lambda function. </exception> <exception cref="T:Amazon.Lambda.Model.EC2UnexpectedException"> AWS Lambda received an unexpected EC2 client exception while setting up for the Lambda function. </exception> <exception cref="T:Amazon.Lambda.Model.ENILimitReachedException"> AWS Lambda was not able to create an Elastic Network Interface (ENI) in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached. </exception> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.InvalidRequestContentException"> The request body could not be parsed as JSON. </exception> <exception cref="T:Amazon.Lambda.Model.InvalidSecurityGroupIDException"> The Security Group ID provided in the Lambda function VPC configuration is invalid. </exception> <exception cref="T:Amazon.Lambda.Model.InvalidSubnetIDException"> The Subnet ID provided in the Lambda function VPC configuration is invalid. </exception> <exception cref="T:Amazon.Lambda.Model.RequestTooLargeException"> The request payload exceeded the <code>Invoke</code> request body JSON input limit. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/limits.html">Limits</a>. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.SubnetIPAddressLimitReachedException"> AWS Lambda was not able to set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> <exception cref="T:Amazon.Lambda.Model.UnsupportedMediaTypeException"> The content type of the <code>Invoke</code> request body is not JSON. </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.InvokeAsync(Amazon.Lambda.Model.InvokeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Invoke operation. </summary> <param name="request">Container for the necessary parameters to execute the Invoke operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.InvokeAsync(Amazon.Lambda.Model.InvokeAsyncRequest)"> <summary> <important>This API is deprecated. We recommend you use <code>Invoke</code> API (see <a>Invoke</a>).</important> <para> Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch Logs console. </para> <para> This operation requires permission for the <code>lambda:InvokeFunction</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the InvokeAsync service method.</param> <returns>The response from the InvokeAsync service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidRequestContentException"> The request body could not be parsed as JSON. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.InvokeAsyncAsync(Amazon.Lambda.Model.InvokeAsyncRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the InvokeAsync operation. </summary> <param name="request">Container for the necessary parameters to execute the InvokeAsync operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.ListAliases(Amazon.Lambda.Model.ListAliasesRequest)"> <summary> Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html">Introduction to AWS Lambda Aliases</a>. <para> This requires permission for the lambda:ListAliases action. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListAliases service method.</param> <returns>The response from the ListAliases service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.ListAliasesAsync(Amazon.Lambda.Model.ListAliasesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAliases operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAliases operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.ListEventSourceMappings(Amazon.Lambda.Model.ListEventSourceMappingsRequest)"> <summary> Returns a list of event source mappings you created using the <code>CreateEventSourceMapping</code> (see <a>CreateEventSourceMapping</a>). <para> For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings. </para> <para> If you are using the versioning feature, you can get list of event source mappings for a specific Lambda function version or an alias as described in the <code>FunctionName</code> parameter. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:ListEventSourceMappings</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListEventSourceMappings service method.</param> <returns>The response from the ListEventSourceMappings service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.ListEventSourceMappingsAsync(Amazon.Lambda.Model.ListEventSourceMappingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListEventSourceMappings operation. </summary> <param name="request">Container for the necessary parameters to execute the ListEventSourceMappings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.ListFunctions"> <summary> Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use <a>GetFunction</a> to retrieve the code for your function. <para> This operation requires permission for the <code>lambda:ListFunctions</code> action. </para> <para> If you are using versioning feature, the response returns list of $LATEST versions of your functions. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> </summary> <returns>The response from the ListFunctions service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.ListFunctions(Amazon.Lambda.Model.ListFunctionsRequest)"> <summary> Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use <a>GetFunction</a> to retrieve the code for your function. <para> This operation requires permission for the <code>lambda:ListFunctions</code> action. </para> <para> If you are using versioning feature, the response returns list of $LATEST versions of your functions. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListFunctions service method.</param> <returns>The response from the ListFunctions service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.ListFunctionsAsync(Amazon.Lambda.Model.ListFunctionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListFunctions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListFunctions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.ListVersionsByFunction(Amazon.Lambda.Model.ListVersionsByFunctionRequest)"> <summary> List all versions of a function. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </summary> <param name="request">Container for the necessary parameters to execute the ListVersionsByFunction service method.</param> <returns>The response from the ListVersionsByFunction service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.ListVersionsByFunctionAsync(Amazon.Lambda.Model.ListVersionsByFunctionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListVersionsByFunction operation. </summary> <param name="request">Container for the necessary parameters to execute the ListVersionsByFunction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.PublishVersion(Amazon.Lambda.Model.PublishVersionRequest)"> <summary> Publishes a version of your function from the current snapshot of $LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from $LATEST and publishes a new version. The code and configuration cannot be modified after publication. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </summary> <param name="request">Container for the necessary parameters to execute the PublishVersion service method.</param> <returns>The response from the PublishVersion service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.CodeStorageExceededException"> You have exceeded your maximum total code size per account. <a href="http://docs.aws.amazon.com/lambda/latest/dg/limits.html">Limits</a> </exception> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.PublishVersionAsync(Amazon.Lambda.Model.PublishVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PublishVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the PublishVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.RemovePermission(Amazon.Lambda.Model.RemovePermissionRequest)"> <summary> You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission. <para> If you are using versioning, the permissions you remove are specific to the Lambda function version or alias you specify in the <code>AddPermission</code> request via the <code>Qualifier</code> parameter. For more information about versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> Note that removal of a permission will cause an active event source to lose permission to the function. </para> <para> You need permission for the <code>lambda:RemovePermission</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the RemovePermission service method.</param> <returns>The response from the RemovePermission service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.RemovePermissionAsync(Amazon.Lambda.Model.RemovePermissionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemovePermission operation. </summary> <param name="request">Container for the necessary parameters to execute the RemovePermission operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.UpdateAlias(Amazon.Lambda.Model.UpdateAliasRequest)"> <summary> Using this API you can update the function version to which the alias points and the alias description. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html">Introduction to AWS Lambda Aliases</a>. <para> This requires permission for the lambda:UpdateAlias action. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAlias service method.</param> <returns>The response from the UpdateAlias service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.UpdateAliasAsync(Amazon.Lambda.Model.UpdateAliasRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAlias operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.UpdateEventSourceMapping(Amazon.Lambda.Model.UpdateEventSourceMappingRequest)"> <summary> You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping. <para> If you are using the versioning feature, you can update the event source mapping to map to a specific Lambda function version or alias as described in the <code>FunctionName</code> parameter. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> If you disable the event source mapping, AWS Lambda stops polling. If you enable again, it will resume polling from the time it had stopped polling, so you don't lose processing of any records. However, if you delete event source mapping and create it again, it will reset. </para> <para> This operation requires permission for the <code>lambda:UpdateEventSourceMapping</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateEventSourceMapping service method.</param> <returns>The response from the UpdateEventSourceMapping service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceConflictException"> The resource already exists. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.UpdateEventSourceMappingAsync(Amazon.Lambda.Model.UpdateEventSourceMappingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateEventSourceMapping operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateEventSourceMapping operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.UpdateFunctionCode(Amazon.Lambda.Model.UpdateFunctionCodeRequest)"> <summary> Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration. <para> If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:UpdateFunctionCode</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateFunctionCode service method.</param> <returns>The response from the UpdateFunctionCode service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.CodeStorageExceededException"> You have exceeded your maximum total code size per account. <a href="http://docs.aws.amazon.com/lambda/latest/dg/limits.html">Limits</a> </exception> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.UpdateFunctionCodeAsync(Amazon.Lambda.Model.UpdateFunctionCodeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateFunctionCode operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateFunctionCode operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.UpdateFunctionConfiguration(Amazon.Lambda.Model.UpdateFunctionConfigurationRequest)"> <summary> Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code. <para> If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html">AWS Lambda Function Versioning and Aliases</a>. </para> <para> This operation requires permission for the <code>lambda:UpdateFunctionConfiguration</code> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateFunctionConfiguration service method.</param> <returns>The response from the UpdateFunctionConfiguration service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidParameterValueException"> One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the <code>CreateFunction</code> or the <code>UpdateFunctionConfiguration</code> API, that AWS Lambda is unable to assume you will get this exception. </exception> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"> The resource (for example, a Lambda function or access policy statement) specified in the request does not exist. </exception> <exception cref="T:Amazon.Lambda.Model.ServiceException"> The AWS Lambda service encountered an internal error. </exception> <exception cref="T:Amazon.Lambda.Model.TooManyRequestsException"> </exception> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.UpdateFunctionConfigurationAsync(Amazon.Lambda.Model.UpdateFunctionConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateFunctionConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateFunctionConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.InvokeAsync(System.String)"> <summary> Submits an invocation request to Lambda. Upon receiving the request, Lambda executes the specified cloud function asynchronously. To see the logs generated by the cloud function execution, see the CloudWatch logs console. <para> This operation requires permission for the <code>lambda:InvokeAsync</code> action. </para> <para> The InvokeArgs will be set to an empty json document. </para> </summary> <param name="functionName">The cloud function to invoke.</param> <returns>The response from the InvokeAsync service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidRequestContentException"/> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Lambda.Model.ServiceException"/> </member> <member name="M:Amazon.Lambda.AmazonLambdaClient.InvokeAsync(System.String,System.String)"> <summary> Submits an invocation request to Lambda. Upon receiving the request, Lambda executes the specified cloud function asynchronously. To see the logs generated by the cloud function execution, see the CloudWatch logs console. <para> This operation requires permission for the <code>lambda:InvokeAsync</code> action. </para> </summary> <param name="functionName">The cloud function to invoke.</param> <param name="invokeArgs">A Json document that will be passed to the cloud function.</param> <returns>The response from the InvokeAsync service method, as returned by Lambda.</returns> <exception cref="T:Amazon.Lambda.Model.InvalidRequestContentException"/> <exception cref="T:Amazon.Lambda.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Lambda.Model.ServiceException"/> </member> <member name="T:Amazon.MachineLearning.AmazonMachineLearningClient"> <summary> Implementation for accessing MachineLearning Definition of the public APIs exposed by Amazon Machine Learning </summary> <summary> Implementation for accessing MachineLearning Definition of the public APIs exposed by Amazon Machine Learning </summary> </member> <member name="T:Amazon.MachineLearning.IAmazonMachineLearning"> <summary> Interface for accessing MachineLearning Definition of the public APIs exposed by Amazon Machine Learning </summary> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.CreateBatchPrediction(Amazon.MachineLearning.Model.CreateBatchPredictionRequest)"> <summary> Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a <code>DataSource</code>. This operation creates a new <code>BatchPrediction</code>, and uses an <code>MLModel</code> and the data files referenced by the <code>DataSource</code> as information sources. <para> <code>CreateBatchPrediction</code> is an asynchronous operation. In response to <code>CreateBatchPrediction</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>BatchPrediction</code> status to <code>PENDING</code>. After the <code>BatchPrediction</code> completes, Amazon ML sets the status to <code>COMPLETED</code>. </para> <para> You can poll for status updates by using the <a>GetBatchPrediction</a> operation and checking the <code>Status</code> parameter of the result. After the <code>COMPLETED</code> status appears, the results are available in the location specified by the <code>OutputUri</code> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateBatchPrediction service method.</param> <returns>The response from the CreateBatchPrediction service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.IdempotentParameterMismatchException"> A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.CreateBatchPredictionAsync(Amazon.MachineLearning.Model.CreateBatchPredictionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateBatchPrediction operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateBatchPrediction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.CreateDataSourceFromRDS(Amazon.MachineLearning.Model.CreateDataSourceFromRDSRequest)"> <summary> Creates a <code>DataSource</code> object from an <a href="http://aws.amazon.com/rds/"> Amazon Relational Database Service</a> (Amazon RDS). A <code>DataSource</code> references data that can be used to perform <a>CreateMLModel</a>, <a>CreateEvaluation</a>, or <a>CreateBatchPrediction</a> operations. <para> <code>CreateDataSourceFromRDS</code> is an asynchronous operation. In response to <code>CreateDataSourceFromRDS</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>DataSource</code> status to <code>PENDING</code>. After the <code>DataSource</code> is created and ready for use, Amazon ML sets the <code>Status</code> parameter to <code>COMPLETED</code>. <code>DataSource</code> in <code>COMPLETED</code> or <code>PENDING</code> status can only be used to perform <a>CreateMLModel</a>, <a>CreateEvaluation</a>, or <a>CreateBatchPrediction</a> operations. </para> <para> If Amazon ML cannot accept the input source, it sets the <code>Status</code> parameter to <code>FAILED</code> and includes an error message in the <code>Message</code> attribute of the <a>GetDataSource</a> operation response. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDataSourceFromRDS service method.</param> <returns>The response from the CreateDataSourceFromRDS service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.IdempotentParameterMismatchException"> A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.CreateDataSourceFromRDSAsync(Amazon.MachineLearning.Model.CreateDataSourceFromRDSRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDataSourceFromRDS operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDataSourceFromRDS operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.CreateDataSourceFromRedshift(Amazon.MachineLearning.Model.CreateDataSourceFromRedshiftRequest)"> <summary> Creates a <code>DataSource</code> from <a href="http://aws.amazon.com/redshift/">Amazon Redshift</a>. A <code>DataSource</code> references data that can be used to perform either <a>CreateMLModel</a>, <a>CreateEvaluation</a> or <a>CreateBatchPrediction</a> operations. <para> <code>CreateDataSourceFromRedshift</code> is an asynchronous operation. In response to <code>CreateDataSourceFromRedshift</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>DataSource</code> status to <code>PENDING</code>. After the <code>DataSource</code> is created and ready for use, Amazon ML sets the <code>Status</code> parameter to <code>COMPLETED</code>. <code>DataSource</code> in <code>COMPLETED</code> or <code>PENDING</code> status can only be used to perform <a>CreateMLModel</a>, <a>CreateEvaluation</a>, or <a>CreateBatchPrediction</a> operations. </para> <para> If Amazon ML cannot accept the input source, it sets the <code>Status</code> parameter to <code>FAILED</code> and includes an error message in the <code>Message</code> attribute of the <a>GetDataSource</a> operation response. </para> <para> The observations should exist in the database hosted on an Amazon Redshift cluster and should be specified by a <code>SelectSqlQuery</code>. Amazon ML executes <a href="http://docs.aws.amazon.com/redshift/latest/dg/t_Unloading_tables.html"> Unload</a> command in Amazon Redshift to transfer the result set of <code>SelectSqlQuery</code> to <code>S3StagingLocation.</code> </para> <para> After the <code>DataSource</code> is created, it's ready for use in evaluations and batch predictions. If you plan to use the <code>DataSource</code> to train an <code>MLModel</code>, the <code>DataSource</code> requires another item -- a recipe. A recipe describes the observation variables that participate in training an <code>MLModel</code>. A recipe describes how each input variable will be used in training. Will the variable be included or excluded from training? Will the variable be manipulated, for example, combined with another variable or split apart into word combinations? The recipe provides answers to these questions. For more information, see the Amazon Machine Learning Developer Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDataSourceFromRedshift service method.</param> <returns>The response from the CreateDataSourceFromRedshift service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.IdempotentParameterMismatchException"> A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.CreateDataSourceFromRedshiftAsync(Amazon.MachineLearning.Model.CreateDataSourceFromRedshiftRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDataSourceFromRedshift operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDataSourceFromRedshift operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.CreateDataSourceFromS3(Amazon.MachineLearning.Model.CreateDataSourceFromS3Request)"> <summary> Creates a <code>DataSource</code> object. A <code>DataSource</code> references data that can be used to perform <a>CreateMLModel</a>, <a>CreateEvaluation</a>, or <a>CreateBatchPrediction</a> operations. <para> <code>CreateDataSourceFromS3</code> is an asynchronous operation. In response to <code>CreateDataSourceFromS3</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>DataSource</code> status to <code>PENDING</code>. After the <code>DataSource</code> is created and ready for use, Amazon ML sets the <code>Status</code> parameter to <code>COMPLETED</code>. <code>DataSource</code> in <code>COMPLETED</code> or <code>PENDING</code> status can only be used to perform <a>CreateMLModel</a>, <a>CreateEvaluation</a> or <a>CreateBatchPrediction</a> operations. </para> <para> If Amazon ML cannot accept the input source, it sets the <code>Status</code> parameter to <code>FAILED</code> and includes an error message in the <code>Message</code> attribute of the <a>GetDataSource</a> operation response. </para> <para> The observation data used in a <code>DataSource</code> should be ready to use; that is, it should have a consistent structure, and missing data values should be kept to a minimum. The observation data must reside in one or more CSV files in an Amazon Simple Storage Service (Amazon S3) bucket, along with a schema that describes the data items by name and type. The same schema must be used for all of the data files referenced by the <code>DataSource</code>. </para> <para> After the <code>DataSource</code> has been created, it's ready to use in evaluations and batch predictions. If you plan to use the <code>DataSource</code> to train an <code>MLModel</code>, the <code>DataSource</code> requires another item: a recipe. A recipe describes the observation variables that participate in training an <code>MLModel</code>. A recipe describes how each input variable will be used in training. Will the variable be included or excluded from training? Will the variable be manipulated, for example, combined with another variable, or split apart into word combinations? The recipe provides answers to these questions. For more information, see the <a href="http://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDataSourceFromS3 service method.</param> <returns>The response from the CreateDataSourceFromS3 service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.IdempotentParameterMismatchException"> A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.CreateDataSourceFromS3Async(Amazon.MachineLearning.Model.CreateDataSourceFromS3Request,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDataSourceFromS3 operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDataSourceFromS3 operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.CreateEvaluation(Amazon.MachineLearning.Model.CreateEvaluationRequest)"> <summary> Creates a new <code>Evaluation</code> of an <code>MLModel</code>. An <code>MLModel</code> is evaluated on a set of observations associated to a <code>DataSource</code>. Like a <code>DataSource</code> for an <code>MLModel</code>, the <code>DataSource</code> for an <code>Evaluation</code> contains values for the Target Variable. The <code>Evaluation</code> compares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective the <code>MLModel</code> functions on the test data. Evaluation generates a relevant performance metric such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the corresponding <code>MLModelType</code>: <code>BINARY</code>, <code>REGRESSION</code> or <code>MULTICLASS</code>. <para> <code>CreateEvaluation</code> is an asynchronous operation. In response to <code>CreateEvaluation</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status to <code>PENDING</code>. After the <code>Evaluation</code> is created and ready for use, Amazon ML sets the status to <code>COMPLETED</code>. </para> <para> You can use the <a>GetEvaluation</a> operation to check progress of the evaluation during the creation operation. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateEvaluation service method.</param> <returns>The response from the CreateEvaluation service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.IdempotentParameterMismatchException"> A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.CreateEvaluationAsync(Amazon.MachineLearning.Model.CreateEvaluationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateEvaluation operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateEvaluation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.CreateMLModel(Amazon.MachineLearning.Model.CreateMLModelRequest)"> <summary> Creates a new <code>MLModel</code> using the data files and the recipe as information sources. <para> An <code>MLModel</code> is nearly immutable. Users can only update the <code>MLModelName</code> and the <code>ScoreThreshold</code> in an <code>MLModel</code> without creating a new <code>MLModel</code>. </para> <para> <code>CreateMLModel</code> is an asynchronous operation. In response to <code>CreateMLModel</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>MLModel</code> status to <code>PENDING</code>. After the <code>MLModel</code> is created and ready for use, Amazon ML sets the status to <code>COMPLETED</code>. </para> <para> You can use the <a>GetMLModel</a> operation to check progress of the <code>MLModel</code> during the creation operation. </para> <para> <a>CreateMLModel</a> requires a <code>DataSource</code> with computed statistics, which can be created by setting <code>ComputeStatistics</code> to <code>true</code> in <a>CreateDataSourceFromRDS</a>, <a>CreateDataSourceFromS3</a>, or <a>CreateDataSourceFromRedshift</a> operations. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateMLModel service method.</param> <returns>The response from the CreateMLModel service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.IdempotentParameterMismatchException"> A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.CreateMLModelAsync(Amazon.MachineLearning.Model.CreateMLModelRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateMLModel operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateMLModel operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.CreateRealtimeEndpoint(System.String)"> <summary> Creates a real-time endpoint for the <code>MLModel</code>. The endpoint contains the URI of the <code>MLModel</code>; that is, the location to send real-time prediction requests for the specified <code>MLModel</code>. </summary> <param name="mlModelId">The ID assigned to the <code>MLModel</code> during creation.</param> <returns>The response from the CreateRealtimeEndpoint service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.CreateRealtimeEndpoint(Amazon.MachineLearning.Model.CreateRealtimeEndpointRequest)"> <summary> Creates a real-time endpoint for the <code>MLModel</code>. The endpoint contains the URI of the <code>MLModel</code>; that is, the location to send real-time prediction requests for the specified <code>MLModel</code>. </summary> <param name="request">Container for the necessary parameters to execute the CreateRealtimeEndpoint service method.</param> <returns>The response from the CreateRealtimeEndpoint service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.CreateRealtimeEndpointAsync(Amazon.MachineLearning.Model.CreateRealtimeEndpointRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateRealtimeEndpoint operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateRealtimeEndpoint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DeleteBatchPrediction(System.String)"> <summary> Assigns the DELETED status to a <code>BatchPrediction</code>, rendering it unusable. <para> After using the <code>DeleteBatchPrediction</code> operation, you can use the <a>GetBatchPrediction</a> operation to verify that the status of the <code>BatchPrediction</code> changed to DELETED. </para> <para> <b>Caution:</b> The result of the <code>DeleteBatchPrediction</code> operation is irreversible. </para> </summary> <param name="batchPredictionId">A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>.</param> <returns>The response from the DeleteBatchPrediction service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DeleteBatchPrediction(Amazon.MachineLearning.Model.DeleteBatchPredictionRequest)"> <summary> Assigns the DELETED status to a <code>BatchPrediction</code>, rendering it unusable. <para> After using the <code>DeleteBatchPrediction</code> operation, you can use the <a>GetBatchPrediction</a> operation to verify that the status of the <code>BatchPrediction</code> changed to DELETED. </para> <para> <b>Caution:</b> The result of the <code>DeleteBatchPrediction</code> operation is irreversible. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteBatchPrediction service method.</param> <returns>The response from the DeleteBatchPrediction service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DeleteBatchPredictionAsync(Amazon.MachineLearning.Model.DeleteBatchPredictionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteBatchPrediction operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBatchPrediction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DeleteDataSource(System.String)"> <summary> Assigns the DELETED status to a <code>DataSource</code>, rendering it unusable. <para> After using the <code>DeleteDataSource</code> operation, you can use the <a>GetDataSource</a> operation to verify that the status of the <code>DataSource</code> changed to DELETED. </para> <para> <b>Caution:</b> The results of the <code>DeleteDataSource</code> operation are irreversible. </para> </summary> <param name="dataSourceId">A user-supplied ID that uniquely identifies the <code>DataSource</code>.</param> <returns>The response from the DeleteDataSource service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DeleteDataSource(Amazon.MachineLearning.Model.DeleteDataSourceRequest)"> <summary> Assigns the DELETED status to a <code>DataSource</code>, rendering it unusable. <para> After using the <code>DeleteDataSource</code> operation, you can use the <a>GetDataSource</a> operation to verify that the status of the <code>DataSource</code> changed to DELETED. </para> <para> <b>Caution:</b> The results of the <code>DeleteDataSource</code> operation are irreversible. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDataSource service method.</param> <returns>The response from the DeleteDataSource service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DeleteDataSourceAsync(Amazon.MachineLearning.Model.DeleteDataSourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDataSource operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDataSource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DeleteEvaluation(System.String)"> <summary> Assigns the <code>DELETED</code> status to an <code>Evaluation</code>, rendering it unusable. <para> After invoking the <code>DeleteEvaluation</code> operation, you can use the <a>GetEvaluation</a> operation to verify that the status of the <code>Evaluation</code> changed to <code>DELETED</code>. </para> <para> <b>Caution:</b> The results of the <code>DeleteEvaluation</code> operation are irreversible. </para> </summary> <param name="evaluationId">A user-supplied ID that uniquely identifies the <code>Evaluation</code> to delete.</param> <returns>The response from the DeleteEvaluation service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DeleteEvaluation(Amazon.MachineLearning.Model.DeleteEvaluationRequest)"> <summary> Assigns the <code>DELETED</code> status to an <code>Evaluation</code>, rendering it unusable. <para> After invoking the <code>DeleteEvaluation</code> operation, you can use the <a>GetEvaluation</a> operation to verify that the status of the <code>Evaluation</code> changed to <code>DELETED</code>. </para> <para> <b>Caution:</b> The results of the <code>DeleteEvaluation</code> operation are irreversible. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteEvaluation service method.</param> <returns>The response from the DeleteEvaluation service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DeleteEvaluationAsync(Amazon.MachineLearning.Model.DeleteEvaluationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteEvaluation operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEvaluation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DeleteMLModel(System.String)"> <summary> Assigns the DELETED status to an <code>MLModel</code>, rendering it unusable. <para> After using the <code>DeleteMLModel</code> operation, you can use the <a>GetMLModel</a> operation to verify that the status of the <code>MLModel</code> changed to DELETED. </para> <para> <b>Caution:</b> The result of the <code>DeleteMLModel</code> operation is irreversible. </para> </summary> <param name="mlModelId">A user-supplied ID that uniquely identifies the <code>MLModel</code>.</param> <returns>The response from the DeleteMLModel service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DeleteMLModel(Amazon.MachineLearning.Model.DeleteMLModelRequest)"> <summary> Assigns the DELETED status to an <code>MLModel</code>, rendering it unusable. <para> After using the <code>DeleteMLModel</code> operation, you can use the <a>GetMLModel</a> operation to verify that the status of the <code>MLModel</code> changed to DELETED. </para> <para> <b>Caution:</b> The result of the <code>DeleteMLModel</code> operation is irreversible. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteMLModel service method.</param> <returns>The response from the DeleteMLModel service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DeleteMLModelAsync(Amazon.MachineLearning.Model.DeleteMLModelRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteMLModel operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteMLModel operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DeleteRealtimeEndpoint(System.String)"> <summary> Deletes a real time endpoint of an <code>MLModel</code>. </summary> <param name="mlModelId">The ID assigned to the <code>MLModel</code> during creation.</param> <returns>The response from the DeleteRealtimeEndpoint service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DeleteRealtimeEndpoint(Amazon.MachineLearning.Model.DeleteRealtimeEndpointRequest)"> <summary> Deletes a real time endpoint of an <code>MLModel</code>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRealtimeEndpoint service method.</param> <returns>The response from the DeleteRealtimeEndpoint service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DeleteRealtimeEndpointAsync(Amazon.MachineLearning.Model.DeleteRealtimeEndpointRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRealtimeEndpoint operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRealtimeEndpoint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DescribeBatchPredictions(Amazon.MachineLearning.Model.DescribeBatchPredictionsRequest)"> <summary> Returns a list of <code>BatchPrediction</code> operations that match the search criteria in the request. </summary> <param name="request">Container for the necessary parameters to execute the DescribeBatchPredictions service method.</param> <returns>The response from the DescribeBatchPredictions service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DescribeBatchPredictionsAsync(Amazon.MachineLearning.Model.DescribeBatchPredictionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeBatchPredictions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeBatchPredictions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DescribeDataSources(Amazon.MachineLearning.Model.DescribeDataSourcesRequest)"> <summary> Returns a list of <code>DataSource</code> that match the search criteria in the request. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDataSources service method.</param> <returns>The response from the DescribeDataSources service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DescribeDataSourcesAsync(Amazon.MachineLearning.Model.DescribeDataSourcesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDataSources operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDataSources operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DescribeEvaluations(Amazon.MachineLearning.Model.DescribeEvaluationsRequest)"> <summary> Returns a list of <code>DescribeEvaluations</code> that match the search criteria in the request. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvaluations service method.</param> <returns>The response from the DescribeEvaluations service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DescribeEvaluationsAsync(Amazon.MachineLearning.Model.DescribeEvaluationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEvaluations operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvaluations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DescribeMLModels(Amazon.MachineLearning.Model.DescribeMLModelsRequest)"> <summary> Returns a list of <code>MLModel</code> that match the search criteria in the request. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMLModels service method.</param> <returns>The response from the DescribeMLModels service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.DescribeMLModelsAsync(Amazon.MachineLearning.Model.DescribeMLModelsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeMLModels operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMLModels operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.GetBatchPrediction(System.String)"> <summary> Returns a <code>BatchPrediction</code> that includes detailed metadata, status, and data file information for a <code>Batch Prediction</code> request. </summary> <param name="batchPredictionId">An ID assigned to the <code>BatchPrediction</code> at creation.</param> <returns>The response from the GetBatchPrediction service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.GetBatchPrediction(Amazon.MachineLearning.Model.GetBatchPredictionRequest)"> <summary> Returns a <code>BatchPrediction</code> that includes detailed metadata, status, and data file information for a <code>Batch Prediction</code> request. </summary> <param name="request">Container for the necessary parameters to execute the GetBatchPrediction service method.</param> <returns>The response from the GetBatchPrediction service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.GetBatchPredictionAsync(Amazon.MachineLearning.Model.GetBatchPredictionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBatchPrediction operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBatchPrediction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.GetDataSource(System.String)"> <summary> Returns a <code>DataSource</code> that includes metadata and data file information, as well as the current status of the <code>DataSource</code>. <para> <code>GetDataSource</code> provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format. </para> </summary> <param name="dataSourceId">The ID assigned to the <code>DataSource</code> at creation.</param> <returns>The response from the GetDataSource service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.GetDataSource(System.String,System.Boolean)"> <summary> Returns a <code>DataSource</code> that includes metadata and data file information, as well as the current status of the <code>DataSource</code>. <para> <code>GetDataSource</code> provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format. </para> </summary> <param name="dataSourceId">The ID assigned to the <code>DataSource</code> at creation.</param> <param name="verbose">Specifies whether the <code>GetDataSource</code> operation should return <code>DataSourceSchema</code>. If true, <code>DataSourceSchema</code> is returned. If false, <code>DataSourceSchema</code> is not returned.</param> <returns>The response from the GetDataSource service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.GetDataSource(Amazon.MachineLearning.Model.GetDataSourceRequest)"> <summary> Returns a <code>DataSource</code> that includes metadata and data file information, as well as the current status of the <code>DataSource</code>. <para> <code>GetDataSource</code> provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetDataSource service method.</param> <returns>The response from the GetDataSource service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.GetDataSourceAsync(Amazon.MachineLearning.Model.GetDataSourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDataSource operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDataSource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.GetEvaluation(System.String)"> <summary> Returns an <code>Evaluation</code> that includes metadata as well as the current status of the <code>Evaluation</code>. </summary> <param name="evaluationId">The ID of the <code>Evaluation</code> to retrieve. The evaluation of each <code>MLModel</code> is recorded and cataloged. The ID provides the means to access the information. </param> <returns>The response from the GetEvaluation service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.GetEvaluation(Amazon.MachineLearning.Model.GetEvaluationRequest)"> <summary> Returns an <code>Evaluation</code> that includes metadata as well as the current status of the <code>Evaluation</code>. </summary> <param name="request">Container for the necessary parameters to execute the GetEvaluation service method.</param> <returns>The response from the GetEvaluation service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.GetEvaluationAsync(Amazon.MachineLearning.Model.GetEvaluationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetEvaluation operation. </summary> <param name="request">Container for the necessary parameters to execute the GetEvaluation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.GetMLModel(System.String)"> <summary> Returns an <code>MLModel</code> that includes detailed metadata, and data source information as well as the current status of the <code>MLModel</code>. <para> <code>GetMLModel</code> provides results in normal or verbose format. </para> </summary> <param name="mlModelId">The ID assigned to the <code>MLModel</code> at creation.</param> <returns>The response from the GetMLModel service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.GetMLModel(System.String,System.Boolean)"> <summary> Returns an <code>MLModel</code> that includes detailed metadata, and data source information as well as the current status of the <code>MLModel</code>. <para> <code>GetMLModel</code> provides results in normal or verbose format. </para> </summary> <param name="mlModelId">The ID assigned to the <code>MLModel</code> at creation.</param> <param name="verbose">Specifies whether the <code>GetMLModel</code> operation should return <code>Recipe</code>. If true, <code>Recipe</code> is returned. If false, <code>Recipe</code> is not returned.</param> <returns>The response from the GetMLModel service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.GetMLModel(Amazon.MachineLearning.Model.GetMLModelRequest)"> <summary> Returns an <code>MLModel</code> that includes detailed metadata, and data source information as well as the current status of the <code>MLModel</code>. <para> <code>GetMLModel</code> provides results in normal or verbose format. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetMLModel service method.</param> <returns>The response from the GetMLModel service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.GetMLModelAsync(Amazon.MachineLearning.Model.GetMLModelRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetMLModel operation. </summary> <param name="request">Container for the necessary parameters to execute the GetMLModel operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.Predict(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Generates a prediction for the observation using the specified <code>ML Model</code>. <note><title>Note</title> <para> Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested. </para> </note> </summary> <param name="mlModelId">A unique identifier of the <code>MLModel</code>.</param> <param name="predictEndpoint">A property of PredictRequest used to execute the Predict service method.</param> <param name="record">A property of PredictRequest used to execute the Predict service method.</param> <returns>The response from the Predict service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.LimitExceededException"> The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as <code>DataSource</code>. </exception> <exception cref="T:Amazon.MachineLearning.Model.PredictorNotMountedException"> The exception is thrown when a predict request is made to an unmounted <code>MLModel</code>. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.Predict(Amazon.MachineLearning.Model.PredictRequest)"> <summary> Generates a prediction for the observation using the specified <code>ML Model</code>. <note><title>Note</title> <para> Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the Predict service method.</param> <returns>The response from the Predict service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.LimitExceededException"> The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as <code>DataSource</code>. </exception> <exception cref="T:Amazon.MachineLearning.Model.PredictorNotMountedException"> The exception is thrown when a predict request is made to an unmounted <code>MLModel</code>. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.PredictAsync(Amazon.MachineLearning.Model.PredictRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Predict operation. </summary> <param name="request">Container for the necessary parameters to execute the Predict operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.UpdateBatchPrediction(System.String,System.String)"> <summary> Updates the <code>BatchPredictionName</code> of a <code>BatchPrediction</code>. <para> You can use the <a>GetBatchPrediction</a> operation to view the contents of the updated data element. </para> </summary> <param name="batchPredictionId">The ID assigned to the <code>BatchPrediction</code> during creation.</param> <param name="batchPredictionName">A new user-supplied name or description of the <code>BatchPrediction</code>.</param> <returns>The response from the UpdateBatchPrediction service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.UpdateBatchPrediction(Amazon.MachineLearning.Model.UpdateBatchPredictionRequest)"> <summary> Updates the <code>BatchPredictionName</code> of a <code>BatchPrediction</code>. <para> You can use the <a>GetBatchPrediction</a> operation to view the contents of the updated data element. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateBatchPrediction service method.</param> <returns>The response from the UpdateBatchPrediction service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.UpdateBatchPredictionAsync(Amazon.MachineLearning.Model.UpdateBatchPredictionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateBatchPrediction operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateBatchPrediction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.UpdateDataSource(System.String,System.String)"> <summary> Updates the <code>DataSourceName</code> of a <code>DataSource</code>. <para> You can use the <a>GetDataSource</a> operation to view the contents of the updated data element. </para> </summary> <param name="dataSourceId">The ID assigned to the <code>DataSource</code> during creation.</param> <param name="dataSourceName">A new user-supplied name or description of the <code>DataSource</code> that will replace the current description. </param> <returns>The response from the UpdateDataSource service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.UpdateDataSource(Amazon.MachineLearning.Model.UpdateDataSourceRequest)"> <summary> Updates the <code>DataSourceName</code> of a <code>DataSource</code>. <para> You can use the <a>GetDataSource</a> operation to view the contents of the updated data element. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateDataSource service method.</param> <returns>The response from the UpdateDataSource service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.UpdateDataSourceAsync(Amazon.MachineLearning.Model.UpdateDataSourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDataSource operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDataSource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.UpdateEvaluation(System.String,System.String)"> <summary> Updates the <code>EvaluationName</code> of an <code>Evaluation</code>. <para> You can use the <a>GetEvaluation</a> operation to view the contents of the updated data element. </para> </summary> <param name="evaluationId">The ID assigned to the <code>Evaluation</code> during creation.</param> <param name="evaluationName">A new user-supplied name or description of the <code>Evaluation</code> that will replace the current content. </param> <returns>The response from the UpdateEvaluation service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.UpdateEvaluation(Amazon.MachineLearning.Model.UpdateEvaluationRequest)"> <summary> Updates the <code>EvaluationName</code> of an <code>Evaluation</code>. <para> You can use the <a>GetEvaluation</a> operation to view the contents of the updated data element. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateEvaluation service method.</param> <returns>The response from the UpdateEvaluation service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.UpdateEvaluationAsync(Amazon.MachineLearning.Model.UpdateEvaluationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateEvaluation operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateEvaluation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.UpdateMLModel(System.String,System.String,System.Single)"> <summary> Updates the <code>MLModelName</code> and the <code>ScoreThreshold</code> of an <code>MLModel</code>. <para> You can use the <a>GetMLModel</a> operation to view the contents of the updated data element. </para> </summary> <param name="mlModelId">The ID assigned to the <code>MLModel</code> during creation.</param> <param name="mlModelName">A user-supplied name or description of the <code>MLModel</code>.</param> <param name="scoreThreshold">The <code>ScoreThreshold</code> used in binary classification <code>MLModel</code> that marks the boundary between a positive prediction and a negative prediction. Output values greater than or equal to the <code>ScoreThreshold</code> receive a positive result from the <code>MLModel</code>, such as <code>true</code>. Output values less than the <code>ScoreThreshold</code> receive a negative response from the <code>MLModel</code>, such as <code>false</code>.</param> <returns>The response from the UpdateMLModel service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.UpdateMLModel(Amazon.MachineLearning.Model.UpdateMLModelRequest)"> <summary> Updates the <code>MLModelName</code> and the <code>ScoreThreshold</code> of an <code>MLModel</code>. <para> You can use the <a>GetMLModel</a> operation to view the contents of the updated data element. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateMLModel service method.</param> <returns>The response from the UpdateMLModel service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.IAmazonMachineLearning.UpdateMLModelAsync(Amazon.MachineLearning.Model.UpdateMLModelRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateMLModel operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateMLModel operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.#ctor"> <summary> Constructs AmazonMachineLearningClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonMachineLearningClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.#ctor(Amazon.MachineLearning.AmazonMachineLearningConfig)"> <summary> Constructs AmazonMachineLearningClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonMachineLearningClient Configuration Object</param> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonMachineLearningClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonMachineLearningClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.MachineLearning.AmazonMachineLearningConfig)"> <summary> Constructs AmazonMachineLearningClient with AWS Credentials and an AmazonMachineLearningClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonMachineLearningClient Configuration Object</param> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonMachineLearningClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonMachineLearningClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.#ctor(System.String,System.String,Amazon.MachineLearning.AmazonMachineLearningConfig)"> <summary> Constructs AmazonMachineLearningClient with AWS Access Key ID, AWS Secret Key and an AmazonMachineLearningClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonMachineLearningClient Configuration Object</param> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonMachineLearningClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonMachineLearningClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.#ctor(System.String,System.String,System.String,Amazon.MachineLearning.AmazonMachineLearningConfig)"> <summary> Constructs AmazonMachineLearningClient with AWS Access Key ID, AWS Secret Key and an AmazonMachineLearningClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonMachineLearningClient Configuration Object</param> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.CreateBatchPrediction(Amazon.MachineLearning.Model.CreateBatchPredictionRequest)"> <summary> Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a <code>DataSource</code>. This operation creates a new <code>BatchPrediction</code>, and uses an <code>MLModel</code> and the data files referenced by the <code>DataSource</code> as information sources. <para> <code>CreateBatchPrediction</code> is an asynchronous operation. In response to <code>CreateBatchPrediction</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>BatchPrediction</code> status to <code>PENDING</code>. After the <code>BatchPrediction</code> completes, Amazon ML sets the status to <code>COMPLETED</code>. </para> <para> You can poll for status updates by using the <a>GetBatchPrediction</a> operation and checking the <code>Status</code> parameter of the result. After the <code>COMPLETED</code> status appears, the results are available in the location specified by the <code>OutputUri</code> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateBatchPrediction service method.</param> <returns>The response from the CreateBatchPrediction service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.IdempotentParameterMismatchException"> A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.CreateBatchPredictionAsync(Amazon.MachineLearning.Model.CreateBatchPredictionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateBatchPrediction operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateBatchPrediction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.CreateDataSourceFromRDS(Amazon.MachineLearning.Model.CreateDataSourceFromRDSRequest)"> <summary> Creates a <code>DataSource</code> object from an <a href="http://aws.amazon.com/rds/"> Amazon Relational Database Service</a> (Amazon RDS). A <code>DataSource</code> references data that can be used to perform <a>CreateMLModel</a>, <a>CreateEvaluation</a>, or <a>CreateBatchPrediction</a> operations. <para> <code>CreateDataSourceFromRDS</code> is an asynchronous operation. In response to <code>CreateDataSourceFromRDS</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>DataSource</code> status to <code>PENDING</code>. After the <code>DataSource</code> is created and ready for use, Amazon ML sets the <code>Status</code> parameter to <code>COMPLETED</code>. <code>DataSource</code> in <code>COMPLETED</code> or <code>PENDING</code> status can only be used to perform <a>CreateMLModel</a>, <a>CreateEvaluation</a>, or <a>CreateBatchPrediction</a> operations. </para> <para> If Amazon ML cannot accept the input source, it sets the <code>Status</code> parameter to <code>FAILED</code> and includes an error message in the <code>Message</code> attribute of the <a>GetDataSource</a> operation response. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDataSourceFromRDS service method.</param> <returns>The response from the CreateDataSourceFromRDS service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.IdempotentParameterMismatchException"> A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.CreateDataSourceFromRDSAsync(Amazon.MachineLearning.Model.CreateDataSourceFromRDSRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDataSourceFromRDS operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDataSourceFromRDS operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.CreateDataSourceFromRedshift(Amazon.MachineLearning.Model.CreateDataSourceFromRedshiftRequest)"> <summary> Creates a <code>DataSource</code> from <a href="http://aws.amazon.com/redshift/">Amazon Redshift</a>. A <code>DataSource</code> references data that can be used to perform either <a>CreateMLModel</a>, <a>CreateEvaluation</a> or <a>CreateBatchPrediction</a> operations. <para> <code>CreateDataSourceFromRedshift</code> is an asynchronous operation. In response to <code>CreateDataSourceFromRedshift</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>DataSource</code> status to <code>PENDING</code>. After the <code>DataSource</code> is created and ready for use, Amazon ML sets the <code>Status</code> parameter to <code>COMPLETED</code>. <code>DataSource</code> in <code>COMPLETED</code> or <code>PENDING</code> status can only be used to perform <a>CreateMLModel</a>, <a>CreateEvaluation</a>, or <a>CreateBatchPrediction</a> operations. </para> <para> If Amazon ML cannot accept the input source, it sets the <code>Status</code> parameter to <code>FAILED</code> and includes an error message in the <code>Message</code> attribute of the <a>GetDataSource</a> operation response. </para> <para> The observations should exist in the database hosted on an Amazon Redshift cluster and should be specified by a <code>SelectSqlQuery</code>. Amazon ML executes <a href="http://docs.aws.amazon.com/redshift/latest/dg/t_Unloading_tables.html"> Unload</a> command in Amazon Redshift to transfer the result set of <code>SelectSqlQuery</code> to <code>S3StagingLocation.</code> </para> <para> After the <code>DataSource</code> is created, it's ready for use in evaluations and batch predictions. If you plan to use the <code>DataSource</code> to train an <code>MLModel</code>, the <code>DataSource</code> requires another item -- a recipe. A recipe describes the observation variables that participate in training an <code>MLModel</code>. A recipe describes how each input variable will be used in training. Will the variable be included or excluded from training? Will the variable be manipulated, for example, combined with another variable or split apart into word combinations? The recipe provides answers to these questions. For more information, see the Amazon Machine Learning Developer Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDataSourceFromRedshift service method.</param> <returns>The response from the CreateDataSourceFromRedshift service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.IdempotentParameterMismatchException"> A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.CreateDataSourceFromRedshiftAsync(Amazon.MachineLearning.Model.CreateDataSourceFromRedshiftRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDataSourceFromRedshift operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDataSourceFromRedshift operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.CreateDataSourceFromS3(Amazon.MachineLearning.Model.CreateDataSourceFromS3Request)"> <summary> Creates a <code>DataSource</code> object. A <code>DataSource</code> references data that can be used to perform <a>CreateMLModel</a>, <a>CreateEvaluation</a>, or <a>CreateBatchPrediction</a> operations. <para> <code>CreateDataSourceFromS3</code> is an asynchronous operation. In response to <code>CreateDataSourceFromS3</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>DataSource</code> status to <code>PENDING</code>. After the <code>DataSource</code> is created and ready for use, Amazon ML sets the <code>Status</code> parameter to <code>COMPLETED</code>. <code>DataSource</code> in <code>COMPLETED</code> or <code>PENDING</code> status can only be used to perform <a>CreateMLModel</a>, <a>CreateEvaluation</a> or <a>CreateBatchPrediction</a> operations. </para> <para> If Amazon ML cannot accept the input source, it sets the <code>Status</code> parameter to <code>FAILED</code> and includes an error message in the <code>Message</code> attribute of the <a>GetDataSource</a> operation response. </para> <para> The observation data used in a <code>DataSource</code> should be ready to use; that is, it should have a consistent structure, and missing data values should be kept to a minimum. The observation data must reside in one or more CSV files in an Amazon Simple Storage Service (Amazon S3) bucket, along with a schema that describes the data items by name and type. The same schema must be used for all of the data files referenced by the <code>DataSource</code>. </para> <para> After the <code>DataSource</code> has been created, it's ready to use in evaluations and batch predictions. If you plan to use the <code>DataSource</code> to train an <code>MLModel</code>, the <code>DataSource</code> requires another item: a recipe. A recipe describes the observation variables that participate in training an <code>MLModel</code>. A recipe describes how each input variable will be used in training. Will the variable be included or excluded from training? Will the variable be manipulated, for example, combined with another variable, or split apart into word combinations? The recipe provides answers to these questions. For more information, see the <a href="http://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDataSourceFromS3 service method.</param> <returns>The response from the CreateDataSourceFromS3 service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.IdempotentParameterMismatchException"> A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.CreateDataSourceFromS3Async(Amazon.MachineLearning.Model.CreateDataSourceFromS3Request,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDataSourceFromS3 operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDataSourceFromS3 operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.CreateEvaluation(Amazon.MachineLearning.Model.CreateEvaluationRequest)"> <summary> Creates a new <code>Evaluation</code> of an <code>MLModel</code>. An <code>MLModel</code> is evaluated on a set of observations associated to a <code>DataSource</code>. Like a <code>DataSource</code> for an <code>MLModel</code>, the <code>DataSource</code> for an <code>Evaluation</code> contains values for the Target Variable. The <code>Evaluation</code> compares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective the <code>MLModel</code> functions on the test data. Evaluation generates a relevant performance metric such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the corresponding <code>MLModelType</code>: <code>BINARY</code>, <code>REGRESSION</code> or <code>MULTICLASS</code>. <para> <code>CreateEvaluation</code> is an asynchronous operation. In response to <code>CreateEvaluation</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status to <code>PENDING</code>. After the <code>Evaluation</code> is created and ready for use, Amazon ML sets the status to <code>COMPLETED</code>. </para> <para> You can use the <a>GetEvaluation</a> operation to check progress of the evaluation during the creation operation. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateEvaluation service method.</param> <returns>The response from the CreateEvaluation service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.IdempotentParameterMismatchException"> A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.CreateEvaluationAsync(Amazon.MachineLearning.Model.CreateEvaluationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateEvaluation operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateEvaluation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.CreateMLModel(Amazon.MachineLearning.Model.CreateMLModelRequest)"> <summary> Creates a new <code>MLModel</code> using the data files and the recipe as information sources. <para> An <code>MLModel</code> is nearly immutable. Users can only update the <code>MLModelName</code> and the <code>ScoreThreshold</code> in an <code>MLModel</code> without creating a new <code>MLModel</code>. </para> <para> <code>CreateMLModel</code> is an asynchronous operation. In response to <code>CreateMLModel</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>MLModel</code> status to <code>PENDING</code>. After the <code>MLModel</code> is created and ready for use, Amazon ML sets the status to <code>COMPLETED</code>. </para> <para> You can use the <a>GetMLModel</a> operation to check progress of the <code>MLModel</code> during the creation operation. </para> <para> <a>CreateMLModel</a> requires a <code>DataSource</code> with computed statistics, which can be created by setting <code>ComputeStatistics</code> to <code>true</code> in <a>CreateDataSourceFromRDS</a>, <a>CreateDataSourceFromS3</a>, or <a>CreateDataSourceFromRedshift</a> operations. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateMLModel service method.</param> <returns>The response from the CreateMLModel service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.IdempotentParameterMismatchException"> A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.CreateMLModelAsync(Amazon.MachineLearning.Model.CreateMLModelRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateMLModel operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateMLModel operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.CreateRealtimeEndpoint(System.String)"> <summary> Creates a real-time endpoint for the <code>MLModel</code>. The endpoint contains the URI of the <code>MLModel</code>; that is, the location to send real-time prediction requests for the specified <code>MLModel</code>. </summary> <param name="mlModelId">The ID assigned to the <code>MLModel</code> during creation.</param> <returns>The response from the CreateRealtimeEndpoint service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.CreateRealtimeEndpoint(Amazon.MachineLearning.Model.CreateRealtimeEndpointRequest)"> <summary> Creates a real-time endpoint for the <code>MLModel</code>. The endpoint contains the URI of the <code>MLModel</code>; that is, the location to send real-time prediction requests for the specified <code>MLModel</code>. </summary> <param name="request">Container for the necessary parameters to execute the CreateRealtimeEndpoint service method.</param> <returns>The response from the CreateRealtimeEndpoint service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.CreateRealtimeEndpointAsync(Amazon.MachineLearning.Model.CreateRealtimeEndpointRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateRealtimeEndpoint operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateRealtimeEndpoint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DeleteBatchPrediction(System.String)"> <summary> Assigns the DELETED status to a <code>BatchPrediction</code>, rendering it unusable. <para> After using the <code>DeleteBatchPrediction</code> operation, you can use the <a>GetBatchPrediction</a> operation to verify that the status of the <code>BatchPrediction</code> changed to DELETED. </para> <para> <b>Caution:</b> The result of the <code>DeleteBatchPrediction</code> operation is irreversible. </para> </summary> <param name="batchPredictionId">A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>.</param> <returns>The response from the DeleteBatchPrediction service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DeleteBatchPrediction(Amazon.MachineLearning.Model.DeleteBatchPredictionRequest)"> <summary> Assigns the DELETED status to a <code>BatchPrediction</code>, rendering it unusable. <para> After using the <code>DeleteBatchPrediction</code> operation, you can use the <a>GetBatchPrediction</a> operation to verify that the status of the <code>BatchPrediction</code> changed to DELETED. </para> <para> <b>Caution:</b> The result of the <code>DeleteBatchPrediction</code> operation is irreversible. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteBatchPrediction service method.</param> <returns>The response from the DeleteBatchPrediction service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DeleteBatchPredictionAsync(Amazon.MachineLearning.Model.DeleteBatchPredictionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteBatchPrediction operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBatchPrediction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DeleteDataSource(System.String)"> <summary> Assigns the DELETED status to a <code>DataSource</code>, rendering it unusable. <para> After using the <code>DeleteDataSource</code> operation, you can use the <a>GetDataSource</a> operation to verify that the status of the <code>DataSource</code> changed to DELETED. </para> <para> <b>Caution:</b> The results of the <code>DeleteDataSource</code> operation are irreversible. </para> </summary> <param name="dataSourceId">A user-supplied ID that uniquely identifies the <code>DataSource</code>.</param> <returns>The response from the DeleteDataSource service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DeleteDataSource(Amazon.MachineLearning.Model.DeleteDataSourceRequest)"> <summary> Assigns the DELETED status to a <code>DataSource</code>, rendering it unusable. <para> After using the <code>DeleteDataSource</code> operation, you can use the <a>GetDataSource</a> operation to verify that the status of the <code>DataSource</code> changed to DELETED. </para> <para> <b>Caution:</b> The results of the <code>DeleteDataSource</code> operation are irreversible. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDataSource service method.</param> <returns>The response from the DeleteDataSource service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DeleteDataSourceAsync(Amazon.MachineLearning.Model.DeleteDataSourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDataSource operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDataSource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DeleteEvaluation(System.String)"> <summary> Assigns the <code>DELETED</code> status to an <code>Evaluation</code>, rendering it unusable. <para> After invoking the <code>DeleteEvaluation</code> operation, you can use the <a>GetEvaluation</a> operation to verify that the status of the <code>Evaluation</code> changed to <code>DELETED</code>. </para> <para> <b>Caution:</b> The results of the <code>DeleteEvaluation</code> operation are irreversible. </para> </summary> <param name="evaluationId">A user-supplied ID that uniquely identifies the <code>Evaluation</code> to delete.</param> <returns>The response from the DeleteEvaluation service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DeleteEvaluation(Amazon.MachineLearning.Model.DeleteEvaluationRequest)"> <summary> Assigns the <code>DELETED</code> status to an <code>Evaluation</code>, rendering it unusable. <para> After invoking the <code>DeleteEvaluation</code> operation, you can use the <a>GetEvaluation</a> operation to verify that the status of the <code>Evaluation</code> changed to <code>DELETED</code>. </para> <para> <b>Caution:</b> The results of the <code>DeleteEvaluation</code> operation are irreversible. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteEvaluation service method.</param> <returns>The response from the DeleteEvaluation service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DeleteEvaluationAsync(Amazon.MachineLearning.Model.DeleteEvaluationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteEvaluation operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEvaluation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DeleteMLModel(System.String)"> <summary> Assigns the DELETED status to an <code>MLModel</code>, rendering it unusable. <para> After using the <code>DeleteMLModel</code> operation, you can use the <a>GetMLModel</a> operation to verify that the status of the <code>MLModel</code> changed to DELETED. </para> <para> <b>Caution:</b> The result of the <code>DeleteMLModel</code> operation is irreversible. </para> </summary> <param name="mlModelId">A user-supplied ID that uniquely identifies the <code>MLModel</code>.</param> <returns>The response from the DeleteMLModel service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DeleteMLModel(Amazon.MachineLearning.Model.DeleteMLModelRequest)"> <summary> Assigns the DELETED status to an <code>MLModel</code>, rendering it unusable. <para> After using the <code>DeleteMLModel</code> operation, you can use the <a>GetMLModel</a> operation to verify that the status of the <code>MLModel</code> changed to DELETED. </para> <para> <b>Caution:</b> The result of the <code>DeleteMLModel</code> operation is irreversible. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteMLModel service method.</param> <returns>The response from the DeleteMLModel service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DeleteMLModelAsync(Amazon.MachineLearning.Model.DeleteMLModelRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteMLModel operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteMLModel operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DeleteRealtimeEndpoint(System.String)"> <summary> Deletes a real time endpoint of an <code>MLModel</code>. </summary> <param name="mlModelId">The ID assigned to the <code>MLModel</code> during creation.</param> <returns>The response from the DeleteRealtimeEndpoint service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DeleteRealtimeEndpoint(Amazon.MachineLearning.Model.DeleteRealtimeEndpointRequest)"> <summary> Deletes a real time endpoint of an <code>MLModel</code>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRealtimeEndpoint service method.</param> <returns>The response from the DeleteRealtimeEndpoint service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DeleteRealtimeEndpointAsync(Amazon.MachineLearning.Model.DeleteRealtimeEndpointRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteRealtimeEndpoint operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRealtimeEndpoint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DescribeBatchPredictions(Amazon.MachineLearning.Model.DescribeBatchPredictionsRequest)"> <summary> Returns a list of <code>BatchPrediction</code> operations that match the search criteria in the request. </summary> <param name="request">Container for the necessary parameters to execute the DescribeBatchPredictions service method.</param> <returns>The response from the DescribeBatchPredictions service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DescribeBatchPredictionsAsync(Amazon.MachineLearning.Model.DescribeBatchPredictionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeBatchPredictions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeBatchPredictions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DescribeDataSources(Amazon.MachineLearning.Model.DescribeDataSourcesRequest)"> <summary> Returns a list of <code>DataSource</code> that match the search criteria in the request. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDataSources service method.</param> <returns>The response from the DescribeDataSources service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DescribeDataSourcesAsync(Amazon.MachineLearning.Model.DescribeDataSourcesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDataSources operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDataSources operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DescribeEvaluations(Amazon.MachineLearning.Model.DescribeEvaluationsRequest)"> <summary> Returns a list of <code>DescribeEvaluations</code> that match the search criteria in the request. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvaluations service method.</param> <returns>The response from the DescribeEvaluations service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DescribeEvaluationsAsync(Amazon.MachineLearning.Model.DescribeEvaluationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEvaluations operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvaluations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DescribeMLModels(Amazon.MachineLearning.Model.DescribeMLModelsRequest)"> <summary> Returns a list of <code>MLModel</code> that match the search criteria in the request. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMLModels service method.</param> <returns>The response from the DescribeMLModels service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.DescribeMLModelsAsync(Amazon.MachineLearning.Model.DescribeMLModelsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeMLModels operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMLModels operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.GetBatchPrediction(System.String)"> <summary> Returns a <code>BatchPrediction</code> that includes detailed metadata, status, and data file information for a <code>Batch Prediction</code> request. </summary> <param name="batchPredictionId">An ID assigned to the <code>BatchPrediction</code> at creation.</param> <returns>The response from the GetBatchPrediction service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.GetBatchPrediction(Amazon.MachineLearning.Model.GetBatchPredictionRequest)"> <summary> Returns a <code>BatchPrediction</code> that includes detailed metadata, status, and data file information for a <code>Batch Prediction</code> request. </summary> <param name="request">Container for the necessary parameters to execute the GetBatchPrediction service method.</param> <returns>The response from the GetBatchPrediction service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.GetBatchPredictionAsync(Amazon.MachineLearning.Model.GetBatchPredictionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBatchPrediction operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBatchPrediction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.GetDataSource(System.String)"> <summary> Returns a <code>DataSource</code> that includes metadata and data file information, as well as the current status of the <code>DataSource</code>. <para> <code>GetDataSource</code> provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format. </para> </summary> <param name="dataSourceId">The ID assigned to the <code>DataSource</code> at creation.</param> <returns>The response from the GetDataSource service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.GetDataSource(System.String,System.Boolean)"> <summary> Returns a <code>DataSource</code> that includes metadata and data file information, as well as the current status of the <code>DataSource</code>. <para> <code>GetDataSource</code> provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format. </para> </summary> <param name="dataSourceId">The ID assigned to the <code>DataSource</code> at creation.</param> <param name="verbose">Specifies whether the <code>GetDataSource</code> operation should return <code>DataSourceSchema</code>. If true, <code>DataSourceSchema</code> is returned. If false, <code>DataSourceSchema</code> is not returned.</param> <returns>The response from the GetDataSource service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.GetDataSource(Amazon.MachineLearning.Model.GetDataSourceRequest)"> <summary> Returns a <code>DataSource</code> that includes metadata and data file information, as well as the current status of the <code>DataSource</code>. <para> <code>GetDataSource</code> provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetDataSource service method.</param> <returns>The response from the GetDataSource service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.GetDataSourceAsync(Amazon.MachineLearning.Model.GetDataSourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDataSource operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDataSource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.GetEvaluation(System.String)"> <summary> Returns an <code>Evaluation</code> that includes metadata as well as the current status of the <code>Evaluation</code>. </summary> <param name="evaluationId">The ID of the <code>Evaluation</code> to retrieve. The evaluation of each <code>MLModel</code> is recorded and cataloged. The ID provides the means to access the information. </param> <returns>The response from the GetEvaluation service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.GetEvaluation(Amazon.MachineLearning.Model.GetEvaluationRequest)"> <summary> Returns an <code>Evaluation</code> that includes metadata as well as the current status of the <code>Evaluation</code>. </summary> <param name="request">Container for the necessary parameters to execute the GetEvaluation service method.</param> <returns>The response from the GetEvaluation service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.GetEvaluationAsync(Amazon.MachineLearning.Model.GetEvaluationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetEvaluation operation. </summary> <param name="request">Container for the necessary parameters to execute the GetEvaluation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.GetMLModel(System.String)"> <summary> Returns an <code>MLModel</code> that includes detailed metadata, and data source information as well as the current status of the <code>MLModel</code>. <para> <code>GetMLModel</code> provides results in normal or verbose format. </para> </summary> <param name="mlModelId">The ID assigned to the <code>MLModel</code> at creation.</param> <returns>The response from the GetMLModel service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.GetMLModel(System.String,System.Boolean)"> <summary> Returns an <code>MLModel</code> that includes detailed metadata, and data source information as well as the current status of the <code>MLModel</code>. <para> <code>GetMLModel</code> provides results in normal or verbose format. </para> </summary> <param name="mlModelId">The ID assigned to the <code>MLModel</code> at creation.</param> <param name="verbose">Specifies whether the <code>GetMLModel</code> operation should return <code>Recipe</code>. If true, <code>Recipe</code> is returned. If false, <code>Recipe</code> is not returned.</param> <returns>The response from the GetMLModel service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.GetMLModel(Amazon.MachineLearning.Model.GetMLModelRequest)"> <summary> Returns an <code>MLModel</code> that includes detailed metadata, and data source information as well as the current status of the <code>MLModel</code>. <para> <code>GetMLModel</code> provides results in normal or verbose format. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetMLModel service method.</param> <returns>The response from the GetMLModel service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.GetMLModelAsync(Amazon.MachineLearning.Model.GetMLModelRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetMLModel operation. </summary> <param name="request">Container for the necessary parameters to execute the GetMLModel operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.Predict(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Generates a prediction for the observation using the specified <code>ML Model</code>. <note><title>Note</title> <para> Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested. </para> </note> </summary> <param name="mlModelId">A unique identifier of the <code>MLModel</code>.</param> <param name="predictEndpoint">A property of PredictRequest used to execute the Predict service method.</param> <param name="record">A property of PredictRequest used to execute the Predict service method.</param> <returns>The response from the Predict service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.LimitExceededException"> The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as <code>DataSource</code>. </exception> <exception cref="T:Amazon.MachineLearning.Model.PredictorNotMountedException"> The exception is thrown when a predict request is made to an unmounted <code>MLModel</code>. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.Predict(Amazon.MachineLearning.Model.PredictRequest)"> <summary> Generates a prediction for the observation using the specified <code>ML Model</code>. <note><title>Note</title> <para> Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the Predict service method.</param> <returns>The response from the Predict service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.LimitExceededException"> The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as <code>DataSource</code>. </exception> <exception cref="T:Amazon.MachineLearning.Model.PredictorNotMountedException"> The exception is thrown when a predict request is made to an unmounted <code>MLModel</code>. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.PredictAsync(Amazon.MachineLearning.Model.PredictRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Predict operation. </summary> <param name="request">Container for the necessary parameters to execute the Predict operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.UpdateBatchPrediction(System.String,System.String)"> <summary> Updates the <code>BatchPredictionName</code> of a <code>BatchPrediction</code>. <para> You can use the <a>GetBatchPrediction</a> operation to view the contents of the updated data element. </para> </summary> <param name="batchPredictionId">The ID assigned to the <code>BatchPrediction</code> during creation.</param> <param name="batchPredictionName">A new user-supplied name or description of the <code>BatchPrediction</code>.</param> <returns>The response from the UpdateBatchPrediction service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.UpdateBatchPrediction(Amazon.MachineLearning.Model.UpdateBatchPredictionRequest)"> <summary> Updates the <code>BatchPredictionName</code> of a <code>BatchPrediction</code>. <para> You can use the <a>GetBatchPrediction</a> operation to view the contents of the updated data element. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateBatchPrediction service method.</param> <returns>The response from the UpdateBatchPrediction service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.UpdateBatchPredictionAsync(Amazon.MachineLearning.Model.UpdateBatchPredictionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateBatchPrediction operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateBatchPrediction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.UpdateDataSource(System.String,System.String)"> <summary> Updates the <code>DataSourceName</code> of a <code>DataSource</code>. <para> You can use the <a>GetDataSource</a> operation to view the contents of the updated data element. </para> </summary> <param name="dataSourceId">The ID assigned to the <code>DataSource</code> during creation.</param> <param name="dataSourceName">A new user-supplied name or description of the <code>DataSource</code> that will replace the current description. </param> <returns>The response from the UpdateDataSource service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.UpdateDataSource(Amazon.MachineLearning.Model.UpdateDataSourceRequest)"> <summary> Updates the <code>DataSourceName</code> of a <code>DataSource</code>. <para> You can use the <a>GetDataSource</a> operation to view the contents of the updated data element. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateDataSource service method.</param> <returns>The response from the UpdateDataSource service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.UpdateDataSourceAsync(Amazon.MachineLearning.Model.UpdateDataSourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDataSource operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDataSource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.UpdateEvaluation(System.String,System.String)"> <summary> Updates the <code>EvaluationName</code> of an <code>Evaluation</code>. <para> You can use the <a>GetEvaluation</a> operation to view the contents of the updated data element. </para> </summary> <param name="evaluationId">The ID assigned to the <code>Evaluation</code> during creation.</param> <param name="evaluationName">A new user-supplied name or description of the <code>Evaluation</code> that will replace the current content. </param> <returns>The response from the UpdateEvaluation service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.UpdateEvaluation(Amazon.MachineLearning.Model.UpdateEvaluationRequest)"> <summary> Updates the <code>EvaluationName</code> of an <code>Evaluation</code>. <para> You can use the <a>GetEvaluation</a> operation to view the contents of the updated data element. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateEvaluation service method.</param> <returns>The response from the UpdateEvaluation service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.UpdateEvaluationAsync(Amazon.MachineLearning.Model.UpdateEvaluationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateEvaluation operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateEvaluation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.UpdateMLModel(System.String,System.String,System.Single)"> <summary> Updates the <code>MLModelName</code> and the <code>ScoreThreshold</code> of an <code>MLModel</code>. <para> You can use the <a>GetMLModel</a> operation to view the contents of the updated data element. </para> </summary> <param name="mlModelId">The ID assigned to the <code>MLModel</code> during creation.</param> <param name="mlModelName">A user-supplied name or description of the <code>MLModel</code>.</param> <param name="scoreThreshold">The <code>ScoreThreshold</code> used in binary classification <code>MLModel</code> that marks the boundary between a positive prediction and a negative prediction. Output values greater than or equal to the <code>ScoreThreshold</code> receive a positive result from the <code>MLModel</code>, such as <code>true</code>. Output values less than the <code>ScoreThreshold</code> receive a negative response from the <code>MLModel</code>, such as <code>false</code>.</param> <returns>The response from the UpdateMLModel service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.UpdateMLModel(Amazon.MachineLearning.Model.UpdateMLModelRequest)"> <summary> Updates the <code>MLModelName</code> and the <code>ScoreThreshold</code> of an <code>MLModel</code>. <para> You can use the <a>GetMLModel</a> operation to view the contents of the updated data element. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateMLModel service method.</param> <returns>The response from the UpdateMLModel service method, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.UpdateMLModelAsync(Amazon.MachineLearning.Model.UpdateMLModelRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateMLModel operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateMLModel operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.AmazonMachineLearningClient.CreateRealtimePredictor(System.String)"> <summary> Creates a simple client that just does realtime predictions. </summary> <remarks> Fetches the realtime prediction endpoint for the specified model using the GetMLModel call. </remarks> <param name="modelId">The model to create the realtime predictor for.</param> <returns>A realtime prediction client.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.LimitExceededException"> The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as <code>DataSource</code>. </exception> <exception cref="T:Amazon.MachineLearning.Model.PredictorNotMountedException"> The exception is thrown when a predict request is made to an unmounted <code>MLModel</code>. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="T:Amazon.MachineLearning.Util.RealtimePredictor"> <summary> A simplified client that just does realtime predictions. </summary> </member> <member name="M:Amazon.MachineLearning.Util.RealtimePredictor.PredictAsync(System.Collections.Generic.Dictionary{System.String,System.String},System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Predict operation. </summary> <param name="record">Data to generate prediction for.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.MachineLearning.Util.RealtimePredictor.#ctor(Amazon.MachineLearning.IAmazonMachineLearning,System.String)"> <summary> Constructs a RealtimePredictor which will use the passed in client to make requests. </summary> <remarks> The endpoint URL will be determined my making a service call to retrieve it. </remarks> <param name="client">The MachineLearning client that will be used to make requests.</param> <param name="modelId">The MachineLearning model to predict against.</param> </member> <member name="M:Amazon.MachineLearning.Util.RealtimePredictor.#ctor(Amazon.MachineLearning.IAmazonMachineLearning,System.String,System.String)"> <summary> Constructs a RealtimePredictor which will use the passed in client to make requests. </summary> <param name="client">The MachineLearning client that will be used to make requests.</param> <param name="modelId">The MachineLearning model to predict against.</param> <param name="endpoint">The endpoint to send requests to.</param> </member> <member name="M:Amazon.MachineLearning.Util.RealtimePredictor.#ctor(System.String)"> <summary> Constructs a RealtimePredictor which construct a client using configured defaults. </summary> <remarks> The endpoint URL will be determined my making a service call to retrieve it. </remarks> <param name="modelId">The MachineLearning model to predict against.</param> </member> <member name="M:Amazon.MachineLearning.Util.RealtimePredictor.Predict(System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Generates a prediction for an observation. </summary> <param name="record">Data to generate a prediction for.</param> <returns>A prediction for the observation, as returned by MachineLearning.</returns> <exception cref="T:Amazon.MachineLearning.Model.InternalServerException"> An error on the server occurred when trying to process a request. </exception> <exception cref="T:Amazon.MachineLearning.Model.InvalidInputException"> An error on the client occurred. Typically, the cause is an invalid input value. </exception> <exception cref="T:Amazon.MachineLearning.Model.LimitExceededException"> The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as <code>DataSource</code>. </exception> <exception cref="T:Amazon.MachineLearning.Model.PredictorNotMountedException"> The exception is thrown when a predict request is made to an unmounted <code>MLModel</code>. </exception> <exception cref="T:Amazon.MachineLearning.Model.ResourceNotFoundException"> A specified resource cannot be located. </exception> </member> <member name="M:Amazon.MachineLearning.Util.RealtimePredictor.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.MachineLearning.Util.RealtimePredictor.Dispose"> <summary> Disposes of all managed and unmanaged resources. </summary> </member> <member name="P:Amazon.MachineLearning.Util.RealtimePredictor.ModelId"> <summary> The Id of the MachineLearning model. </summary> </member> <member name="P:Amazon.MachineLearning.Util.RealtimePredictor.Endpoint"> <summary> The realtime prediction endpoint for the given MLModel. </summary> </member> <member name="T:Amazon.OpsWorks.AmazonOpsWorksClient"> <summary> Implementation for accessing OpsWorks AWS OpsWorks <para> Welcome to the <i>AWS OpsWorks API Reference</i>. This guide provides descriptions, syntax, and usage examples about AWS OpsWorks actions and data types, including common parameters and error codes. </para> <para> AWS OpsWorks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the <a href="http://aws.amazon.com/opsworks/">AWS OpsWorks</a> details page. </para> <para> <b>SDKs and CLI</b> </para> <para> The most common way to use the AWS OpsWorks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see: </para> <ul> <li> <a href="http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">AWS CLI</a> </li> <li> <a href="http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html">AWS SDK for Java</a> </li> <li> <a href="http://docs.aws.amazon.com/sdkfornet/latest/apidocs/html/N_Amazon_OpsWorks.htm">AWS SDK for .NET</a> </li> <li> <a href="http://docs.aws.amazon.com/aws-sdk-php-2/latest/class-Aws.OpsWorks.OpsWorksClient.html">AWS SDK for PHP 2</a> </li> <li> <a href="http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/OpsWorks/Client.html">AWS SDK for Ruby</a> </li> <li> <a href="http://aws.amazon.com/documentation/sdkforjavascript/">AWS SDK for Node.js</a> </li> <li> <a href="http://docs.pythonboto.org/en/latest/ref/opsworks.html">AWS SDK for Python(Boto)</a> </li> </ul> <para> <b>Endpoints</b> </para> <para> AWS OpsWorks supports only one endpoint, opsworks.us-east-1.amazonaws.com (HTTPS), so you must connect to that endpoint. You can then use the API to direct AWS OpsWorks to create stacks in any AWS Region. </para> <para> <b>Chef Versions</b> </para> <para> When you call <a>CreateStack</a>, <a>CloneStack</a>, or <a>UpdateStack</a> we recommend you use the <code>ConfigurationManager</code> parameter to specify the Chef version. The recommended value for Linux stacks is currently 12 (the default is 11.4). Windows stacks use Chef 12.2. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-chef11.html">Chef Versions</a>. </para> <note>You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.</note> </summary> </member> <member name="T:Amazon.OpsWorks.IAmazonOpsWorks"> <summary> Interface for accessing OpsWorks AWS OpsWorks <para> Welcome to the <i>AWS OpsWorks API Reference</i>. This guide provides descriptions, syntax, and usage examples about AWS OpsWorks actions and data types, including common parameters and error codes. </para> <para> AWS OpsWorks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the <a href="http://aws.amazon.com/opsworks/">AWS OpsWorks</a> details page. </para> <para> <b>SDKs and CLI</b> </para> <para> The most common way to use the AWS OpsWorks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see: </para> <ul> <li> <a href="http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">AWS CLI</a> </li> <li> <a href="http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html">AWS SDK for Java</a> </li> <li> <a href="http://docs.aws.amazon.com/sdkfornet/latest/apidocs/html/N_Amazon_OpsWorks.htm">AWS SDK for .NET</a> </li> <li> <a href="http://docs.aws.amazon.com/aws-sdk-php-2/latest/class-Aws.OpsWorks.OpsWorksClient.html">AWS SDK for PHP 2</a> </li> <li> <a href="http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/OpsWorks/Client.html">AWS SDK for Ruby</a> </li> <li> <a href="http://aws.amazon.com/documentation/sdkforjavascript/">AWS SDK for Node.js</a> </li> <li> <a href="http://docs.pythonboto.org/en/latest/ref/opsworks.html">AWS SDK for Python(Boto)</a> </li> </ul> <para> <b>Endpoints</b> </para> <para> AWS OpsWorks supports only one endpoint, opsworks.us-east-1.amazonaws.com (HTTPS), so you must connect to that endpoint. You can then use the API to direct AWS OpsWorks to create stacks in any AWS Region. </para> <para> <b>Chef Versions</b> </para> <para> When you call <a>CreateStack</a>, <a>CloneStack</a>, or <a>UpdateStack</a> we recommend you use the <code>ConfigurationManager</code> parameter to specify the Chef version. The recommended value for Linux stacks is currently 12 (the default is 11.4). Windows stacks use Chef 12.2. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-chef11.html">Chef Versions</a>. </para> <note>You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.</note> </summary> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.AssignInstance(Amazon.OpsWorks.Model.AssignInstanceRequest)"> <summary> Assign a registered instance to a layer. <ul> <li>You can assign registered on-premises instances to any layer type.</li> <li>You can assign registered Amazon EC2 instances only to custom layers.</li> <li>You cannot use this action with instances that were created with AWS OpsWorks.</li> </ul> <para> <b>Required Permissions</b>: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssignInstance service method.</param> <returns>The response from the AssignInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.AssignInstanceAsync(Amazon.OpsWorks.Model.AssignInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssignInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the AssignInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.AssignVolume(Amazon.OpsWorks.Model.AssignVolumeRequest)"> <summary> Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling <a>RegisterVolume</a>. After you register the volume, you must call <a>UpdateVolume</a> to specify a mount point before calling <code>AssignVolume</code>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssignVolume service method.</param> <returns>The response from the AssignVolume service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.AssignVolumeAsync(Amazon.OpsWorks.Model.AssignVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssignVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the AssignVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.AssociateElasticIp(Amazon.OpsWorks.Model.AssociateElasticIpRequest)"> <summary> Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling <a>RegisterElasticIp</a>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssociateElasticIp service method.</param> <returns>The response from the AssociateElasticIp service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.AssociateElasticIpAsync(Amazon.OpsWorks.Model.AssociateElasticIpRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssociateElasticIp operation. </summary> <param name="request">Container for the necessary parameters to execute the AssociateElasticIp operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.AttachElasticLoadBalancer(Amazon.OpsWorks.Model.AttachElasticLoadBalancerRequest)"> <summary> Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/load-balancer-elb.html">Elastic Load Balancing</a>. <note> <para> You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/Welcome.html"> Elastic Load Balancing Developer Guide</a>. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachElasticLoadBalancer service method.</param> <returns>The response from the AttachElasticLoadBalancer service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.AttachElasticLoadBalancerAsync(Amazon.OpsWorks.Model.AttachElasticLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachElasticLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachElasticLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.CloneStack(Amazon.OpsWorks.Model.CloneStackRequest)"> <summary> Creates a clone of a specified stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-cloning.html">Clone a Stack</a>. By default, all parameters are set to the values used by the parent stack. <para> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CloneStack service method.</param> <returns>The response from the CloneStack service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.CloneStackAsync(Amazon.OpsWorks.Model.CloneStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CloneStack operation. </summary> <param name="request">Container for the necessary parameters to execute the CloneStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.CreateApp(Amazon.OpsWorks.Model.CreateAppRequest)"> <summary> Creates an app for a specified stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html">Creating Apps</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateApp service method.</param> <returns>The response from the CreateApp service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.CreateAppAsync(Amazon.OpsWorks.Model.CreateAppRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateApp operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateApp operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.CreateDeployment(Amazon.OpsWorks.Model.CreateDeploymentRequest)"> <summary> Runs deployment or stack commands. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploying.html">Deploying Apps</a> and <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-commands.html">Run Stack Commands</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDeployment service method.</param> <returns>The response from the CreateDeployment service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.CreateDeploymentAsync(Amazon.OpsWorks.Model.CreateDeploymentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDeployment operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeployment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.CreateInstance(Amazon.OpsWorks.Model.CreateInstanceRequest)"> <summary> Creates an instance in a specified stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html">Adding an Instance to a Layer</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateInstance service method.</param> <returns>The response from the CreateInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.CreateInstanceAsync(Amazon.OpsWorks.Model.CreateInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.CreateLayer(Amazon.OpsWorks.Model.CreateLayerRequest)"> <summary> Creates a layer. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-create.html">How to Create a Layer</a>. <note> <para> You should use <b>CreateLayer</b> for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, <b>CreateLayer</b> fails. A stack can have an arbitrary number of custom layers, so you can call <b>CreateLayer</b> as many times as you like for that layer type. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLayer service method.</param> <returns>The response from the CreateLayer service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.CreateLayerAsync(Amazon.OpsWorks.Model.CreateLayerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLayer operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLayer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.CreateStack(Amazon.OpsWorks.Model.CreateStackRequest)"> <summary> Creates a new stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-edit.html">Create a New Stack</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateStack service method.</param> <returns>The response from the CreateStack service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.CreateStackAsync(Amazon.OpsWorks.Model.CreateStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateStack operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.CreateUserProfile(Amazon.OpsWorks.Model.CreateUserProfileRequest)"> <summary> Creates a new user profile. <para> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateUserProfile service method.</param> <returns>The response from the CreateUserProfile service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.CreateUserProfileAsync(Amazon.OpsWorks.Model.CreateUserProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateUserProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateUserProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeleteApp(Amazon.OpsWorks.Model.DeleteAppRequest)"> <summary> Deletes a specified app. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteApp service method.</param> <returns>The response from the DeleteApp service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeleteAppAsync(Amazon.OpsWorks.Model.DeleteAppRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteApp operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteApp operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeleteInstance(Amazon.OpsWorks.Model.DeleteInstanceRequest)"> <summary> Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it. <para> For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-delete.html">Deleting Instances</a>. </para> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteInstance service method.</param> <returns>The response from the DeleteInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeleteInstanceAsync(Amazon.OpsWorks.Model.DeleteInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeleteLayer(Amazon.OpsWorks.Model.DeleteLayerRequest)"> <summary> Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-delete.html">How to Delete a Layer</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLayer service method.</param> <returns>The response from the DeleteLayer service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeleteLayerAsync(Amazon.OpsWorks.Model.DeleteLayerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLayer operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLayer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeleteStack(Amazon.OpsWorks.Model.DeleteStackRequest)"> <summary> Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-shutting.html">Shut Down a Stack</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteStack service method.</param> <returns>The response from the DeleteStack service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeleteStackAsync(Amazon.OpsWorks.Model.DeleteStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteStack operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeleteUserProfile(Amazon.OpsWorks.Model.DeleteUserProfileRequest)"> <summary> Deletes a user profile. <para> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteUserProfile service method.</param> <returns>The response from the DeleteUserProfile service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeleteUserProfileAsync(Amazon.OpsWorks.Model.DeleteUserProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteUserProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteUserProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeregisterEcsCluster(Amazon.OpsWorks.Model.DeregisterEcsClusterRequest)"> <summary> Deregisters a specified Amazon ECS cluster from a stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html#workinglayers-ecscluster-delete"> Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html"/>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterEcsCluster service method.</param> <returns>The response from the DeregisterEcsCluster service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeregisterEcsClusterAsync(Amazon.OpsWorks.Model.DeregisterEcsClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterEcsCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterEcsCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeregisterElasticIp(Amazon.OpsWorks.Model.DeregisterElasticIpRequest)"> <summary> Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterElasticIp service method.</param> <returns>The response from the DeregisterElasticIp service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeregisterElasticIpAsync(Amazon.OpsWorks.Model.DeregisterElasticIpRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterElasticIp operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterElasticIp operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeregisterInstance(Amazon.OpsWorks.Model.DeregisterInstanceRequest)"> <summary> Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS OpsWorks. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterInstance service method.</param> <returns>The response from the DeregisterInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeregisterInstanceAsync(Amazon.OpsWorks.Model.DeregisterInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeregisterRdsDbInstance(Amazon.OpsWorks.Model.DeregisterRdsDbInstanceRequest)"> <summary> Deregisters an Amazon RDS instance. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterRdsDbInstance service method.</param> <returns>The response from the DeregisterRdsDbInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeregisterRdsDbInstanceAsync(Amazon.OpsWorks.Model.DeregisterRdsDbInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterRdsDbInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterRdsDbInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeregisterVolume(Amazon.OpsWorks.Model.DeregisterVolumeRequest)"> <summary> Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterVolume service method.</param> <returns>The response from the DeregisterVolume service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DeregisterVolumeAsync(Amazon.OpsWorks.Model.DeregisterVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeAgentVersions(Amazon.OpsWorks.Model.DescribeAgentVersionsRequest)"> <summary> Describes the available AWS OpsWorks agent versions. You must specify a stack ID or a configuration manager. <code>DescribeAgentVersions</code> returns a list of available agent versions for the specified stack or configuration manager. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAgentVersions service method.</param> <returns>The response from the DescribeAgentVersions service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeAgentVersionsAsync(Amazon.OpsWorks.Model.DescribeAgentVersionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAgentVersions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAgentVersions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeApps(Amazon.OpsWorks.Model.DescribeAppsRequest)"> <summary> Requests a description of a specified set of apps. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeApps service method.</param> <returns>The response from the DescribeApps service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeAppsAsync(Amazon.OpsWorks.Model.DescribeAppsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeApps operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeApps operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeCommands(Amazon.OpsWorks.Model.DescribeCommandsRequest)"> <summary> Describes the results of specified commands. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCommands service method.</param> <returns>The response from the DescribeCommands service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeCommandsAsync(Amazon.OpsWorks.Model.DescribeCommandsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCommands operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCommands operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeDeployments(Amazon.OpsWorks.Model.DescribeDeploymentsRequest)"> <summary> Requests a description of a specified set of deployments. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeployments service method.</param> <returns>The response from the DescribeDeployments service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeDeploymentsAsync(Amazon.OpsWorks.Model.DescribeDeploymentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDeployments operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeployments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeEcsClusters(Amazon.OpsWorks.Model.DescribeEcsClustersRequest)"> <summary> Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the <code>MaxResults</code> and <code>NextToken</code> parameters to paginate the response. However, AWS OpsWorks currently supports only one cluster per layer, so the result set has a maximum of one element. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEcsClusters service method.</param> <returns>The response from the DescribeEcsClusters service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeEcsClustersAsync(Amazon.OpsWorks.Model.DescribeEcsClustersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEcsClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEcsClusters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeElasticIps(Amazon.OpsWorks.Model.DescribeElasticIpsRequest)"> <summary> Describes <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP addresses</a>. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeElasticIps service method.</param> <returns>The response from the DescribeElasticIps service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeElasticIpsAsync(Amazon.OpsWorks.Model.DescribeElasticIpsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeElasticIps operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeElasticIps operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeElasticLoadBalancers"> <summary> Describes a stack's Elastic Load Balancing instances. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <returns>The response from the DescribeElasticLoadBalancers service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeElasticLoadBalancers(Amazon.OpsWorks.Model.DescribeElasticLoadBalancersRequest)"> <summary> Describes a stack's Elastic Load Balancing instances. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeElasticLoadBalancers service method.</param> <returns>The response from the DescribeElasticLoadBalancers service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeElasticLoadBalancersAsync(Amazon.OpsWorks.Model.DescribeElasticLoadBalancersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeElasticLoadBalancers operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeElasticLoadBalancers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeInstances(Amazon.OpsWorks.Model.DescribeInstancesRequest)"> <summary> Requests a description of a set of instances. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstances service method.</param> <returns>The response from the DescribeInstances service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeInstancesAsync(Amazon.OpsWorks.Model.DescribeInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeLayers(Amazon.OpsWorks.Model.DescribeLayersRequest)"> <summary> Requests a description of one or more layers in a specified stack. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLayers service method.</param> <returns>The response from the DescribeLayers service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeLayersAsync(Amazon.OpsWorks.Model.DescribeLayersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLayers operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLayers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeLoadBasedAutoScaling(Amazon.OpsWorks.Model.DescribeLoadBasedAutoScalingRequest)"> <summary> Describes load-based auto scaling configurations for specified layers. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBasedAutoScaling service method.</param> <returns>The response from the DescribeLoadBasedAutoScaling service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeLoadBasedAutoScalingAsync(Amazon.OpsWorks.Model.DescribeLoadBasedAutoScalingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLoadBasedAutoScaling operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBasedAutoScaling operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeMyUserProfile"> <summary> Describes a user's SSH information. <para> <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <returns>The response from the DescribeMyUserProfile service method, as returned by OpsWorks.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeMyUserProfile(Amazon.OpsWorks.Model.DescribeMyUserProfileRequest)"> <summary> Describes a user's SSH information. <para> <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeMyUserProfile service method.</param> <returns>The response from the DescribeMyUserProfile service method, as returned by OpsWorks.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeMyUserProfileAsync(Amazon.OpsWorks.Model.DescribeMyUserProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeMyUserProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMyUserProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribePermissions(Amazon.OpsWorks.Model.DescribePermissionsRequest)"> <summary> Describes the permissions for a specified stack. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribePermissions service method.</param> <returns>The response from the DescribePermissions service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribePermissionsAsync(Amazon.OpsWorks.Model.DescribePermissionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribePermissions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePermissions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeRaidArrays(Amazon.OpsWorks.Model.DescribeRaidArraysRequest)"> <summary> Describe an instance's RAID arrays. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeRaidArrays service method.</param> <returns>The response from the DescribeRaidArrays service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeRaidArraysAsync(Amazon.OpsWorks.Model.DescribeRaidArraysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeRaidArrays operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRaidArrays operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeRdsDbInstances(Amazon.OpsWorks.Model.DescribeRdsDbInstancesRequest)"> <summary> Describes Amazon RDS instances. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeRdsDbInstances service method.</param> <returns>The response from the DescribeRdsDbInstances service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeRdsDbInstancesAsync(Amazon.OpsWorks.Model.DescribeRdsDbInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeRdsDbInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRdsDbInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeServiceErrors"> <summary> Describes AWS OpsWorks service errors. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <returns>The response from the DescribeServiceErrors service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeServiceErrors(Amazon.OpsWorks.Model.DescribeServiceErrorsRequest)"> <summary> Describes AWS OpsWorks service errors. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceErrors service method.</param> <returns>The response from the DescribeServiceErrors service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeServiceErrorsAsync(Amazon.OpsWorks.Model.DescribeServiceErrorsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeServiceErrors operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceErrors operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeStackProvisioningParameters(Amazon.OpsWorks.Model.DescribeStackProvisioningParametersRequest)"> <summary> Requests a description of a stack's provisioning parameters. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackProvisioningParameters service method.</param> <returns>The response from the DescribeStackProvisioningParameters service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeStackProvisioningParametersAsync(Amazon.OpsWorks.Model.DescribeStackProvisioningParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStackProvisioningParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackProvisioningParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeStacks"> <summary> Requests a description of one or more stacks. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <returns>The response from the DescribeStacks service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeStacks(Amazon.OpsWorks.Model.DescribeStacksRequest)"> <summary> Requests a description of one or more stacks. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStacks service method.</param> <returns>The response from the DescribeStacks service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeStacksAsync(Amazon.OpsWorks.Model.DescribeStacksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStacks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStacks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeStackSummary(Amazon.OpsWorks.Model.DescribeStackSummaryRequest)"> <summary> Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as <code>running_setup</code> or <code>online</code>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackSummary service method.</param> <returns>The response from the DescribeStackSummary service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeStackSummaryAsync(Amazon.OpsWorks.Model.DescribeStackSummaryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStackSummary operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackSummary operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeTimeBasedAutoScaling(Amazon.OpsWorks.Model.DescribeTimeBasedAutoScalingRequest)"> <summary> Describes time-based auto scaling configurations for specified instances. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTimeBasedAutoScaling service method.</param> <returns>The response from the DescribeTimeBasedAutoScaling service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeTimeBasedAutoScalingAsync(Amazon.OpsWorks.Model.DescribeTimeBasedAutoScalingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTimeBasedAutoScaling operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTimeBasedAutoScaling operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeUserProfiles"> <summary> Describe specified users. <para> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <returns>The response from the DescribeUserProfiles service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeUserProfiles(Amazon.OpsWorks.Model.DescribeUserProfilesRequest)"> <summary> Describe specified users. <para> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeUserProfiles service method.</param> <returns>The response from the DescribeUserProfiles service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeUserProfilesAsync(Amazon.OpsWorks.Model.DescribeUserProfilesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeUserProfiles operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeUserProfiles operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeVolumes(Amazon.OpsWorks.Model.DescribeVolumesRequest)"> <summary> Describes an instance's Amazon EBS volumes. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumes service method.</param> <returns>The response from the DescribeVolumes service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DescribeVolumesAsync(Amazon.OpsWorks.Model.DescribeVolumesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVolumes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DetachElasticLoadBalancer(Amazon.OpsWorks.Model.DetachElasticLoadBalancerRequest)"> <summary> Detaches a specified Elastic Load Balancing instance from its layer. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachElasticLoadBalancer service method.</param> <returns>The response from the DetachElasticLoadBalancer service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DetachElasticLoadBalancerAsync(Amazon.OpsWorks.Model.DetachElasticLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachElasticLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachElasticLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DisassociateElasticIp(Amazon.OpsWorks.Model.DisassociateElasticIpRequest)"> <summary> Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DisassociateElasticIp service method.</param> <returns>The response from the DisassociateElasticIp service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.DisassociateElasticIpAsync(Amazon.OpsWorks.Model.DisassociateElasticIpRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisassociateElasticIp operation. </summary> <param name="request">Container for the necessary parameters to execute the DisassociateElasticIp operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.GetHostnameSuggestion(Amazon.OpsWorks.Model.GetHostnameSuggestionRequest)"> <summary> Gets a generated host name for the specified layer, based on the current host name theme. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetHostnameSuggestion service method.</param> <returns>The response from the GetHostnameSuggestion service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.GetHostnameSuggestionAsync(Amazon.OpsWorks.Model.GetHostnameSuggestionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetHostnameSuggestion operation. </summary> <param name="request">Container for the necessary parameters to execute the GetHostnameSuggestion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.GrantAccess(Amazon.OpsWorks.Model.GrantAccessRequest)"> <summary> <note>This action can be used only with Windows stacks.</note> <para> Grants RDP access to a Windows instance for a specified time period. </para> </summary> <param name="request">Container for the necessary parameters to execute the GrantAccess service method.</param> <returns>The response from the GrantAccess service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.GrantAccessAsync(Amazon.OpsWorks.Model.GrantAccessRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GrantAccess operation. </summary> <param name="request">Container for the necessary parameters to execute the GrantAccess operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.RebootInstance(Amazon.OpsWorks.Model.RebootInstanceRequest)"> <summary> Reboots a specified instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting Instances</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RebootInstance service method.</param> <returns>The response from the RebootInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.RebootInstanceAsync(Amazon.OpsWorks.Model.RebootInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RebootInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the RebootInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.RegisterEcsCluster(Amazon.OpsWorks.Model.RegisterEcsClusterRequest)"> <summary> Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html"> Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html"> Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterEcsCluster service method.</param> <returns>The response from the RegisterEcsCluster service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.RegisterEcsClusterAsync(Amazon.OpsWorks.Model.RegisterEcsClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterEcsCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterEcsCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.RegisterElasticIp(Amazon.OpsWorks.Model.RegisterElasticIpRequest)"> <summary> Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling <a>DeregisterElasticIp</a>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterElasticIp service method.</param> <returns>The response from the RegisterElasticIp service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.RegisterElasticIpAsync(Amazon.OpsWorks.Model.RegisterElasticIpRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterElasticIp operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterElasticIp operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.RegisterInstance(Amazon.OpsWorks.Model.RegisterInstanceRequest)"> <summary> Registers instances with a specified stack that were created outside of AWS OpsWorks. <note>We do not recommend using this action to register instances. The complete registration operation has two primary steps, installing the AWS OpsWorks agent on the instance and registering the instance with the stack. <code>RegisterInstance</code> handles only the second step. You should instead use the AWS CLI <code>register</code> command, which performs the entire registration operation. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register.html"> Registering an Instance with an AWS OpsWorks Stack</a>.</note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterInstance service method.</param> <returns>The response from the RegisterInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.RegisterInstanceAsync(Amazon.OpsWorks.Model.RegisterInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.RegisterRdsDbInstance(Amazon.OpsWorks.Model.RegisterRdsDbInstanceRequest)"> <summary> Registers an Amazon RDS instance with a stack. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterRdsDbInstance service method.</param> <returns>The response from the RegisterRdsDbInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.RegisterRdsDbInstanceAsync(Amazon.OpsWorks.Model.RegisterRdsDbInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterRdsDbInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterRdsDbInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.RegisterVolume(Amazon.OpsWorks.Model.RegisterVolumeRequest)"> <summary> Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling <a>DeregisterVolume</a>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterVolume service method.</param> <returns>The response from the RegisterVolume service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.RegisterVolumeAsync(Amazon.OpsWorks.Model.RegisterVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.SetLoadBasedAutoScaling(Amazon.OpsWorks.Model.SetLoadBasedAutoScalingRequest)"> <summary> Specify the load-based auto scaling configuration for a specified layer. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html">Managing Load with Time-based and Load-based Instances</a>. <note> <para> To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetLoadBasedAutoScaling service method.</param> <returns>The response from the SetLoadBasedAutoScaling service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.SetLoadBasedAutoScalingAsync(Amazon.OpsWorks.Model.SetLoadBasedAutoScalingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetLoadBasedAutoScaling operation. </summary> <param name="request">Container for the necessary parameters to execute the SetLoadBasedAutoScaling operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.SetPermission(Amazon.OpsWorks.Model.SetPermissionRequest)"> <summary> Specifies a user's permissions. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingsecurity.html">Security and Permissions</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetPermission service method.</param> <returns>The response from the SetPermission service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.SetPermissionAsync(Amazon.OpsWorks.Model.SetPermissionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetPermission operation. </summary> <param name="request">Container for the necessary parameters to execute the SetPermission operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.SetTimeBasedAutoScaling(Amazon.OpsWorks.Model.SetTimeBasedAutoScalingRequest)"> <summary> Specify the time-based auto scaling configuration for a specified instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html">Managing Load with Time-based and Load-based Instances</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetTimeBasedAutoScaling service method.</param> <returns>The response from the SetTimeBasedAutoScaling service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.SetTimeBasedAutoScalingAsync(Amazon.OpsWorks.Model.SetTimeBasedAutoScalingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetTimeBasedAutoScaling operation. </summary> <param name="request">Container for the necessary parameters to execute the SetTimeBasedAutoScaling operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.StartInstance(Amazon.OpsWorks.Model.StartInstanceRequest)"> <summary> Starts a specified instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting Instances</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StartInstance service method.</param> <returns>The response from the StartInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.StartInstanceAsync(Amazon.OpsWorks.Model.StartInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the StartInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.StartStack(Amazon.OpsWorks.Model.StartStackRequest)"> <summary> Starts a stack's instances. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StartStack service method.</param> <returns>The response from the StartStack service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.StartStackAsync(Amazon.OpsWorks.Model.StartStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartStack operation. </summary> <param name="request">Container for the necessary parameters to execute the StartStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.StopInstance(Amazon.OpsWorks.Model.StopInstanceRequest)"> <summary> Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting Instances</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StopInstance service method.</param> <returns>The response from the StopInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.StopInstanceAsync(Amazon.OpsWorks.Model.StopInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StopInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the StopInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.StopStack(Amazon.OpsWorks.Model.StopStackRequest)"> <summary> Stops a specified stack. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StopStack service method.</param> <returns>The response from the StopStack service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.StopStackAsync(Amazon.OpsWorks.Model.StopStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StopStack operation. </summary> <param name="request">Container for the necessary parameters to execute the StopStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UnassignInstance(Amazon.OpsWorks.Model.UnassignInstanceRequest)"> <summary> Unassigns a registered instance from all of it's layers. The instance remains in the stack as an unassigned instance and can be assigned to another layer, as needed. You cannot use this action with instances that were created with AWS OpsWorks. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UnassignInstance service method.</param> <returns>The response from the UnassignInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UnassignInstanceAsync(Amazon.OpsWorks.Model.UnassignInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UnassignInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the UnassignInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UnassignVolume(Amazon.OpsWorks.Model.UnassignVolumeRequest)"> <summary> Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UnassignVolume service method.</param> <returns>The response from the UnassignVolume service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UnassignVolumeAsync(Amazon.OpsWorks.Model.UnassignVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UnassignVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the UnassignVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateApp(Amazon.OpsWorks.Model.UpdateAppRequest)"> <summary> Updates a specified app. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateApp service method.</param> <returns>The response from the UpdateApp service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateAppAsync(Amazon.OpsWorks.Model.UpdateAppRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateApp operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateApp operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateElasticIp(Amazon.OpsWorks.Model.UpdateElasticIpRequest)"> <summary> Updates a registered Elastic IP address's name. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateElasticIp service method.</param> <returns>The response from the UpdateElasticIp service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateElasticIpAsync(Amazon.OpsWorks.Model.UpdateElasticIpRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateElasticIp operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateElasticIp operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateInstance(Amazon.OpsWorks.Model.UpdateInstanceRequest)"> <summary> Updates a specified instance. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateInstance service method.</param> <returns>The response from the UpdateInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateInstanceAsync(Amazon.OpsWorks.Model.UpdateInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateLayer(Amazon.OpsWorks.Model.UpdateLayerRequest)"> <summary> Updates a specified layer. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateLayer service method.</param> <returns>The response from the UpdateLayer service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateLayerAsync(Amazon.OpsWorks.Model.UpdateLayerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateLayer operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateLayer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateMyUserProfile"> <summary> Updates a user's SSH public key. <para> <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <returns>The response from the UpdateMyUserProfile service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateMyUserProfile(Amazon.OpsWorks.Model.UpdateMyUserProfileRequest)"> <summary> Updates a user's SSH public key. <para> <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateMyUserProfile service method.</param> <returns>The response from the UpdateMyUserProfile service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateMyUserProfileAsync(Amazon.OpsWorks.Model.UpdateMyUserProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateMyUserProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateMyUserProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateRdsDbInstance(Amazon.OpsWorks.Model.UpdateRdsDbInstanceRequest)"> <summary> Updates an Amazon RDS instance. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateRdsDbInstance service method.</param> <returns>The response from the UpdateRdsDbInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateRdsDbInstanceAsync(Amazon.OpsWorks.Model.UpdateRdsDbInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateRdsDbInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRdsDbInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateStack(Amazon.OpsWorks.Model.UpdateStackRequest)"> <summary> Updates a specified stack. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateStack service method.</param> <returns>The response from the UpdateStack service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateStackAsync(Amazon.OpsWorks.Model.UpdateStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateStack operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateUserProfile(Amazon.OpsWorks.Model.UpdateUserProfileRequest)"> <summary> Updates a specified user profile. <para> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateUserProfile service method.</param> <returns>The response from the UpdateUserProfile service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateUserProfileAsync(Amazon.OpsWorks.Model.UpdateUserProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateUserProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateUserProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateVolume(Amazon.OpsWorks.Model.UpdateVolumeRequest)"> <summary> Updates an Amazon EBS volume's name or mount point. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateVolume service method.</param> <returns>The response from the UpdateVolume service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.IAmazonOpsWorks.UpdateVolumeAsync(Amazon.OpsWorks.Model.UpdateVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.#ctor"> <summary> Constructs AmazonOpsWorksClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonOpsWorksClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.#ctor(Amazon.OpsWorks.AmazonOpsWorksConfig)"> <summary> Constructs AmazonOpsWorksClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonOpsWorksClient Configuration Object</param> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonOpsWorksClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonOpsWorksClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.OpsWorks.AmazonOpsWorksConfig)"> <summary> Constructs AmazonOpsWorksClient with AWS Credentials and an AmazonOpsWorksClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonOpsWorksClient Configuration Object</param> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonOpsWorksClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonOpsWorksClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.#ctor(System.String,System.String,Amazon.OpsWorks.AmazonOpsWorksConfig)"> <summary> Constructs AmazonOpsWorksClient with AWS Access Key ID, AWS Secret Key and an AmazonOpsWorksClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonOpsWorksClient Configuration Object</param> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonOpsWorksClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonOpsWorksClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.#ctor(System.String,System.String,System.String,Amazon.OpsWorks.AmazonOpsWorksConfig)"> <summary> Constructs AmazonOpsWorksClient with AWS Access Key ID, AWS Secret Key and an AmazonOpsWorksClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonOpsWorksClient Configuration Object</param> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.AssignInstance(Amazon.OpsWorks.Model.AssignInstanceRequest)"> <summary> Assign a registered instance to a layer. <ul> <li>You can assign registered on-premises instances to any layer type.</li> <li>You can assign registered Amazon EC2 instances only to custom layers.</li> <li>You cannot use this action with instances that were created with AWS OpsWorks.</li> </ul> <para> <b>Required Permissions</b>: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssignInstance service method.</param> <returns>The response from the AssignInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.AssignInstanceAsync(Amazon.OpsWorks.Model.AssignInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssignInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the AssignInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.AssignVolume(Amazon.OpsWorks.Model.AssignVolumeRequest)"> <summary> Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling <a>RegisterVolume</a>. After you register the volume, you must call <a>UpdateVolume</a> to specify a mount point before calling <code>AssignVolume</code>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssignVolume service method.</param> <returns>The response from the AssignVolume service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.AssignVolumeAsync(Amazon.OpsWorks.Model.AssignVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssignVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the AssignVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.AssociateElasticIp(Amazon.OpsWorks.Model.AssociateElasticIpRequest)"> <summary> Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling <a>RegisterElasticIp</a>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssociateElasticIp service method.</param> <returns>The response from the AssociateElasticIp service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.AssociateElasticIpAsync(Amazon.OpsWorks.Model.AssociateElasticIpRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssociateElasticIp operation. </summary> <param name="request">Container for the necessary parameters to execute the AssociateElasticIp operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.AttachElasticLoadBalancer(Amazon.OpsWorks.Model.AttachElasticLoadBalancerRequest)"> <summary> Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/load-balancer-elb.html">Elastic Load Balancing</a>. <note> <para> You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/Welcome.html"> Elastic Load Balancing Developer Guide</a>. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachElasticLoadBalancer service method.</param> <returns>The response from the AttachElasticLoadBalancer service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.AttachElasticLoadBalancerAsync(Amazon.OpsWorks.Model.AttachElasticLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AttachElasticLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachElasticLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.CloneStack(Amazon.OpsWorks.Model.CloneStackRequest)"> <summary> Creates a clone of a specified stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-cloning.html">Clone a Stack</a>. By default, all parameters are set to the values used by the parent stack. <para> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CloneStack service method.</param> <returns>The response from the CloneStack service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.CloneStackAsync(Amazon.OpsWorks.Model.CloneStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CloneStack operation. </summary> <param name="request">Container for the necessary parameters to execute the CloneStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.CreateApp(Amazon.OpsWorks.Model.CreateAppRequest)"> <summary> Creates an app for a specified stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html">Creating Apps</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateApp service method.</param> <returns>The response from the CreateApp service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.CreateAppAsync(Amazon.OpsWorks.Model.CreateAppRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateApp operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateApp operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.CreateDeployment(Amazon.OpsWorks.Model.CreateDeploymentRequest)"> <summary> Runs deployment or stack commands. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploying.html">Deploying Apps</a> and <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-commands.html">Run Stack Commands</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDeployment service method.</param> <returns>The response from the CreateDeployment service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.CreateDeploymentAsync(Amazon.OpsWorks.Model.CreateDeploymentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDeployment operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeployment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.CreateInstance(Amazon.OpsWorks.Model.CreateInstanceRequest)"> <summary> Creates an instance in a specified stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html">Adding an Instance to a Layer</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateInstance service method.</param> <returns>The response from the CreateInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.CreateInstanceAsync(Amazon.OpsWorks.Model.CreateInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.CreateLayer(Amazon.OpsWorks.Model.CreateLayerRequest)"> <summary> Creates a layer. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-create.html">How to Create a Layer</a>. <note> <para> You should use <b>CreateLayer</b> for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, <b>CreateLayer</b> fails. A stack can have an arbitrary number of custom layers, so you can call <b>CreateLayer</b> as many times as you like for that layer type. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLayer service method.</param> <returns>The response from the CreateLayer service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.CreateLayerAsync(Amazon.OpsWorks.Model.CreateLayerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateLayer operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLayer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.CreateStack(Amazon.OpsWorks.Model.CreateStackRequest)"> <summary> Creates a new stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-edit.html">Create a New Stack</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateStack service method.</param> <returns>The response from the CreateStack service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.CreateStackAsync(Amazon.OpsWorks.Model.CreateStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateStack operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.CreateUserProfile(Amazon.OpsWorks.Model.CreateUserProfileRequest)"> <summary> Creates a new user profile. <para> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateUserProfile service method.</param> <returns>The response from the CreateUserProfile service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.CreateUserProfileAsync(Amazon.OpsWorks.Model.CreateUserProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateUserProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateUserProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeleteApp(Amazon.OpsWorks.Model.DeleteAppRequest)"> <summary> Deletes a specified app. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteApp service method.</param> <returns>The response from the DeleteApp service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeleteAppAsync(Amazon.OpsWorks.Model.DeleteAppRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteApp operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteApp operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeleteInstance(Amazon.OpsWorks.Model.DeleteInstanceRequest)"> <summary> Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it. <para> For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-delete.html">Deleting Instances</a>. </para> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteInstance service method.</param> <returns>The response from the DeleteInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeleteInstanceAsync(Amazon.OpsWorks.Model.DeleteInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeleteLayer(Amazon.OpsWorks.Model.DeleteLayerRequest)"> <summary> Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-delete.html">How to Delete a Layer</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLayer service method.</param> <returns>The response from the DeleteLayer service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeleteLayerAsync(Amazon.OpsWorks.Model.DeleteLayerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLayer operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLayer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeleteStack(Amazon.OpsWorks.Model.DeleteStackRequest)"> <summary> Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-shutting.html">Shut Down a Stack</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteStack service method.</param> <returns>The response from the DeleteStack service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeleteStackAsync(Amazon.OpsWorks.Model.DeleteStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteStack operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeleteUserProfile(Amazon.OpsWorks.Model.DeleteUserProfileRequest)"> <summary> Deletes a user profile. <para> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteUserProfile service method.</param> <returns>The response from the DeleteUserProfile service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeleteUserProfileAsync(Amazon.OpsWorks.Model.DeleteUserProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteUserProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteUserProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeregisterEcsCluster(Amazon.OpsWorks.Model.DeregisterEcsClusterRequest)"> <summary> Deregisters a specified Amazon ECS cluster from a stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html#workinglayers-ecscluster-delete"> Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html"/>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterEcsCluster service method.</param> <returns>The response from the DeregisterEcsCluster service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeregisterEcsClusterAsync(Amazon.OpsWorks.Model.DeregisterEcsClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterEcsCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterEcsCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeregisterElasticIp(Amazon.OpsWorks.Model.DeregisterElasticIpRequest)"> <summary> Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterElasticIp service method.</param> <returns>The response from the DeregisterElasticIp service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeregisterElasticIpAsync(Amazon.OpsWorks.Model.DeregisterElasticIpRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterElasticIp operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterElasticIp operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeregisterInstance(Amazon.OpsWorks.Model.DeregisterInstanceRequest)"> <summary> Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS OpsWorks. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterInstance service method.</param> <returns>The response from the DeregisterInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeregisterInstanceAsync(Amazon.OpsWorks.Model.DeregisterInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeregisterRdsDbInstance(Amazon.OpsWorks.Model.DeregisterRdsDbInstanceRequest)"> <summary> Deregisters an Amazon RDS instance. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterRdsDbInstance service method.</param> <returns>The response from the DeregisterRdsDbInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeregisterRdsDbInstanceAsync(Amazon.OpsWorks.Model.DeregisterRdsDbInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterRdsDbInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterRdsDbInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeregisterVolume(Amazon.OpsWorks.Model.DeregisterVolumeRequest)"> <summary> Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterVolume service method.</param> <returns>The response from the DeregisterVolume service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DeregisterVolumeAsync(Amazon.OpsWorks.Model.DeregisterVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeregisterVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeAgentVersions(Amazon.OpsWorks.Model.DescribeAgentVersionsRequest)"> <summary> Describes the available AWS OpsWorks agent versions. You must specify a stack ID or a configuration manager. <code>DescribeAgentVersions</code> returns a list of available agent versions for the specified stack or configuration manager. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAgentVersions service method.</param> <returns>The response from the DescribeAgentVersions service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeAgentVersionsAsync(Amazon.OpsWorks.Model.DescribeAgentVersionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAgentVersions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAgentVersions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeApps(Amazon.OpsWorks.Model.DescribeAppsRequest)"> <summary> Requests a description of a specified set of apps. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeApps service method.</param> <returns>The response from the DescribeApps service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeAppsAsync(Amazon.OpsWorks.Model.DescribeAppsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeApps operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeApps operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeCommands(Amazon.OpsWorks.Model.DescribeCommandsRequest)"> <summary> Describes the results of specified commands. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCommands service method.</param> <returns>The response from the DescribeCommands service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeCommandsAsync(Amazon.OpsWorks.Model.DescribeCommandsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCommands operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCommands operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeDeployments(Amazon.OpsWorks.Model.DescribeDeploymentsRequest)"> <summary> Requests a description of a specified set of deployments. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeployments service method.</param> <returns>The response from the DescribeDeployments service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeDeploymentsAsync(Amazon.OpsWorks.Model.DescribeDeploymentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDeployments operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeployments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeEcsClusters(Amazon.OpsWorks.Model.DescribeEcsClustersRequest)"> <summary> Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the <code>MaxResults</code> and <code>NextToken</code> parameters to paginate the response. However, AWS OpsWorks currently supports only one cluster per layer, so the result set has a maximum of one element. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEcsClusters service method.</param> <returns>The response from the DescribeEcsClusters service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeEcsClustersAsync(Amazon.OpsWorks.Model.DescribeEcsClustersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEcsClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEcsClusters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeElasticIps(Amazon.OpsWorks.Model.DescribeElasticIpsRequest)"> <summary> Describes <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP addresses</a>. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeElasticIps service method.</param> <returns>The response from the DescribeElasticIps service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeElasticIpsAsync(Amazon.OpsWorks.Model.DescribeElasticIpsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeElasticIps operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeElasticIps operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeElasticLoadBalancers"> <summary> Describes a stack's Elastic Load Balancing instances. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <returns>The response from the DescribeElasticLoadBalancers service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeElasticLoadBalancers(Amazon.OpsWorks.Model.DescribeElasticLoadBalancersRequest)"> <summary> Describes a stack's Elastic Load Balancing instances. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeElasticLoadBalancers service method.</param> <returns>The response from the DescribeElasticLoadBalancers service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeElasticLoadBalancersAsync(Amazon.OpsWorks.Model.DescribeElasticLoadBalancersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeElasticLoadBalancers operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeElasticLoadBalancers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeInstances(Amazon.OpsWorks.Model.DescribeInstancesRequest)"> <summary> Requests a description of a set of instances. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstances service method.</param> <returns>The response from the DescribeInstances service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeInstancesAsync(Amazon.OpsWorks.Model.DescribeInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeLayers(Amazon.OpsWorks.Model.DescribeLayersRequest)"> <summary> Requests a description of one or more layers in a specified stack. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLayers service method.</param> <returns>The response from the DescribeLayers service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeLayersAsync(Amazon.OpsWorks.Model.DescribeLayersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLayers operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLayers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeLoadBasedAutoScaling(Amazon.OpsWorks.Model.DescribeLoadBasedAutoScalingRequest)"> <summary> Describes load-based auto scaling configurations for specified layers. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBasedAutoScaling service method.</param> <returns>The response from the DescribeLoadBasedAutoScaling service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeLoadBasedAutoScalingAsync(Amazon.OpsWorks.Model.DescribeLoadBasedAutoScalingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLoadBasedAutoScaling operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBasedAutoScaling operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeMyUserProfile"> <summary> Describes a user's SSH information. <para> <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <returns>The response from the DescribeMyUserProfile service method, as returned by OpsWorks.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeMyUserProfile(Amazon.OpsWorks.Model.DescribeMyUserProfileRequest)"> <summary> Describes a user's SSH information. <para> <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeMyUserProfile service method.</param> <returns>The response from the DescribeMyUserProfile service method, as returned by OpsWorks.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeMyUserProfileAsync(Amazon.OpsWorks.Model.DescribeMyUserProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeMyUserProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMyUserProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribePermissions(Amazon.OpsWorks.Model.DescribePermissionsRequest)"> <summary> Describes the permissions for a specified stack. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribePermissions service method.</param> <returns>The response from the DescribePermissions service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribePermissionsAsync(Amazon.OpsWorks.Model.DescribePermissionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribePermissions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePermissions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeRaidArrays(Amazon.OpsWorks.Model.DescribeRaidArraysRequest)"> <summary> Describe an instance's RAID arrays. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeRaidArrays service method.</param> <returns>The response from the DescribeRaidArrays service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeRaidArraysAsync(Amazon.OpsWorks.Model.DescribeRaidArraysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeRaidArrays operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRaidArrays operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeRdsDbInstances(Amazon.OpsWorks.Model.DescribeRdsDbInstancesRequest)"> <summary> Describes Amazon RDS instances. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeRdsDbInstances service method.</param> <returns>The response from the DescribeRdsDbInstances service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeRdsDbInstancesAsync(Amazon.OpsWorks.Model.DescribeRdsDbInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeRdsDbInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRdsDbInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeServiceErrors"> <summary> Describes AWS OpsWorks service errors. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <returns>The response from the DescribeServiceErrors service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeServiceErrors(Amazon.OpsWorks.Model.DescribeServiceErrorsRequest)"> <summary> Describes AWS OpsWorks service errors. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceErrors service method.</param> <returns>The response from the DescribeServiceErrors service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeServiceErrorsAsync(Amazon.OpsWorks.Model.DescribeServiceErrorsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeServiceErrors operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceErrors operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeStackProvisioningParameters(Amazon.OpsWorks.Model.DescribeStackProvisioningParametersRequest)"> <summary> Requests a description of a stack's provisioning parameters. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackProvisioningParameters service method.</param> <returns>The response from the DescribeStackProvisioningParameters service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeStackProvisioningParametersAsync(Amazon.OpsWorks.Model.DescribeStackProvisioningParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStackProvisioningParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackProvisioningParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeStacks"> <summary> Requests a description of one or more stacks. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <returns>The response from the DescribeStacks service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeStacks(Amazon.OpsWorks.Model.DescribeStacksRequest)"> <summary> Requests a description of one or more stacks. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStacks service method.</param> <returns>The response from the DescribeStacks service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeStacksAsync(Amazon.OpsWorks.Model.DescribeStacksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStacks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStacks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeStackSummary(Amazon.OpsWorks.Model.DescribeStackSummaryRequest)"> <summary> Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as <code>running_setup</code> or <code>online</code>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackSummary service method.</param> <returns>The response from the DescribeStackSummary service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeStackSummaryAsync(Amazon.OpsWorks.Model.DescribeStackSummaryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStackSummary operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackSummary operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeTimeBasedAutoScaling(Amazon.OpsWorks.Model.DescribeTimeBasedAutoScalingRequest)"> <summary> Describes time-based auto scaling configurations for specified instances. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTimeBasedAutoScaling service method.</param> <returns>The response from the DescribeTimeBasedAutoScaling service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeTimeBasedAutoScalingAsync(Amazon.OpsWorks.Model.DescribeTimeBasedAutoScalingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTimeBasedAutoScaling operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTimeBasedAutoScaling operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeUserProfiles"> <summary> Describe specified users. <para> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <returns>The response from the DescribeUserProfiles service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeUserProfiles(Amazon.OpsWorks.Model.DescribeUserProfilesRequest)"> <summary> Describe specified users. <para> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeUserProfiles service method.</param> <returns>The response from the DescribeUserProfiles service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeUserProfilesAsync(Amazon.OpsWorks.Model.DescribeUserProfilesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeUserProfiles operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeUserProfiles operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeVolumes(Amazon.OpsWorks.Model.DescribeVolumesRequest)"> <summary> Describes an instance's Amazon EBS volumes. <note> <para> You must specify at least one of the parameters. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumes service method.</param> <returns>The response from the DescribeVolumes service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DescribeVolumesAsync(Amazon.OpsWorks.Model.DescribeVolumesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVolumes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DetachElasticLoadBalancer(Amazon.OpsWorks.Model.DetachElasticLoadBalancerRequest)"> <summary> Detaches a specified Elastic Load Balancing instance from its layer. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachElasticLoadBalancer service method.</param> <returns>The response from the DetachElasticLoadBalancer service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DetachElasticLoadBalancerAsync(Amazon.OpsWorks.Model.DetachElasticLoadBalancerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DetachElasticLoadBalancer operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachElasticLoadBalancer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DisassociateElasticIp(Amazon.OpsWorks.Model.DisassociateElasticIpRequest)"> <summary> Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DisassociateElasticIp service method.</param> <returns>The response from the DisassociateElasticIp service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.DisassociateElasticIpAsync(Amazon.OpsWorks.Model.DisassociateElasticIpRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisassociateElasticIp operation. </summary> <param name="request">Container for the necessary parameters to execute the DisassociateElasticIp operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.GetHostnameSuggestion(Amazon.OpsWorks.Model.GetHostnameSuggestionRequest)"> <summary> Gets a generated host name for the specified layer, based on the current host name theme. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetHostnameSuggestion service method.</param> <returns>The response from the GetHostnameSuggestion service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.GetHostnameSuggestionAsync(Amazon.OpsWorks.Model.GetHostnameSuggestionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetHostnameSuggestion operation. </summary> <param name="request">Container for the necessary parameters to execute the GetHostnameSuggestion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.GrantAccess(Amazon.OpsWorks.Model.GrantAccessRequest)"> <summary> <note>This action can be used only with Windows stacks.</note> <para> Grants RDP access to a Windows instance for a specified time period. </para> </summary> <param name="request">Container for the necessary parameters to execute the GrantAccess service method.</param> <returns>The response from the GrantAccess service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.GrantAccessAsync(Amazon.OpsWorks.Model.GrantAccessRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GrantAccess operation. </summary> <param name="request">Container for the necessary parameters to execute the GrantAccess operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.RebootInstance(Amazon.OpsWorks.Model.RebootInstanceRequest)"> <summary> Reboots a specified instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting Instances</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RebootInstance service method.</param> <returns>The response from the RebootInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.RebootInstanceAsync(Amazon.OpsWorks.Model.RebootInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RebootInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the RebootInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.RegisterEcsCluster(Amazon.OpsWorks.Model.RegisterEcsClusterRequest)"> <summary> Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html"> Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html"> Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterEcsCluster service method.</param> <returns>The response from the RegisterEcsCluster service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.RegisterEcsClusterAsync(Amazon.OpsWorks.Model.RegisterEcsClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterEcsCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterEcsCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.RegisterElasticIp(Amazon.OpsWorks.Model.RegisterElasticIpRequest)"> <summary> Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling <a>DeregisterElasticIp</a>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterElasticIp service method.</param> <returns>The response from the RegisterElasticIp service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.RegisterElasticIpAsync(Amazon.OpsWorks.Model.RegisterElasticIpRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterElasticIp operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterElasticIp operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.RegisterInstance(Amazon.OpsWorks.Model.RegisterInstanceRequest)"> <summary> Registers instances with a specified stack that were created outside of AWS OpsWorks. <note>We do not recommend using this action to register instances. The complete registration operation has two primary steps, installing the AWS OpsWorks agent on the instance and registering the instance with the stack. <code>RegisterInstance</code> handles only the second step. You should instead use the AWS CLI <code>register</code> command, which performs the entire registration operation. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register.html"> Registering an Instance with an AWS OpsWorks Stack</a>.</note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterInstance service method.</param> <returns>The response from the RegisterInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.RegisterInstanceAsync(Amazon.OpsWorks.Model.RegisterInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.RegisterRdsDbInstance(Amazon.OpsWorks.Model.RegisterRdsDbInstanceRequest)"> <summary> Registers an Amazon RDS instance with a stack. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterRdsDbInstance service method.</param> <returns>The response from the RegisterRdsDbInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.RegisterRdsDbInstanceAsync(Amazon.OpsWorks.Model.RegisterRdsDbInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterRdsDbInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterRdsDbInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.RegisterVolume(Amazon.OpsWorks.Model.RegisterVolumeRequest)"> <summary> Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling <a>DeregisterVolume</a>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterVolume service method.</param> <returns>The response from the RegisterVolume service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.RegisterVolumeAsync(Amazon.OpsWorks.Model.RegisterVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.SetLoadBasedAutoScaling(Amazon.OpsWorks.Model.SetLoadBasedAutoScalingRequest)"> <summary> Specify the load-based auto scaling configuration for a specified layer. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html">Managing Load with Time-based and Load-based Instances</a>. <note> <para> To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load. </para> </note> <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetLoadBasedAutoScaling service method.</param> <returns>The response from the SetLoadBasedAutoScaling service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.SetLoadBasedAutoScalingAsync(Amazon.OpsWorks.Model.SetLoadBasedAutoScalingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetLoadBasedAutoScaling operation. </summary> <param name="request">Container for the necessary parameters to execute the SetLoadBasedAutoScaling operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.SetPermission(Amazon.OpsWorks.Model.SetPermissionRequest)"> <summary> Specifies a user's permissions. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingsecurity.html">Security and Permissions</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetPermission service method.</param> <returns>The response from the SetPermission service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.SetPermissionAsync(Amazon.OpsWorks.Model.SetPermissionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetPermission operation. </summary> <param name="request">Container for the necessary parameters to execute the SetPermission operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.SetTimeBasedAutoScaling(Amazon.OpsWorks.Model.SetTimeBasedAutoScalingRequest)"> <summary> Specify the time-based auto scaling configuration for a specified instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html">Managing Load with Time-based and Load-based Instances</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetTimeBasedAutoScaling service method.</param> <returns>The response from the SetTimeBasedAutoScaling service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.SetTimeBasedAutoScalingAsync(Amazon.OpsWorks.Model.SetTimeBasedAutoScalingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetTimeBasedAutoScaling operation. </summary> <param name="request">Container for the necessary parameters to execute the SetTimeBasedAutoScaling operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.StartInstance(Amazon.OpsWorks.Model.StartInstanceRequest)"> <summary> Starts a specified instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting Instances</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StartInstance service method.</param> <returns>The response from the StartInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.StartInstanceAsync(Amazon.OpsWorks.Model.StartInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the StartInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.StartStack(Amazon.OpsWorks.Model.StartStackRequest)"> <summary> Starts a stack's instances. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StartStack service method.</param> <returns>The response from the StartStack service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.StartStackAsync(Amazon.OpsWorks.Model.StartStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartStack operation. </summary> <param name="request">Container for the necessary parameters to execute the StartStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.StopInstance(Amazon.OpsWorks.Model.StopInstanceRequest)"> <summary> Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting Instances</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StopInstance service method.</param> <returns>The response from the StopInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.StopInstanceAsync(Amazon.OpsWorks.Model.StopInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StopInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the StopInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.StopStack(Amazon.OpsWorks.Model.StopStackRequest)"> <summary> Stops a specified stack. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StopStack service method.</param> <returns>The response from the StopStack service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.StopStackAsync(Amazon.OpsWorks.Model.StopStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StopStack operation. </summary> <param name="request">Container for the necessary parameters to execute the StopStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UnassignInstance(Amazon.OpsWorks.Model.UnassignInstanceRequest)"> <summary> Unassigns a registered instance from all of it's layers. The instance remains in the stack as an unassigned instance and can be assigned to another layer, as needed. You cannot use this action with instances that were created with AWS OpsWorks. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UnassignInstance service method.</param> <returns>The response from the UnassignInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UnassignInstanceAsync(Amazon.OpsWorks.Model.UnassignInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UnassignInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the UnassignInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UnassignVolume(Amazon.OpsWorks.Model.UnassignVolumeRequest)"> <summary> Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UnassignVolume service method.</param> <returns>The response from the UnassignVolume service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UnassignVolumeAsync(Amazon.OpsWorks.Model.UnassignVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UnassignVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the UnassignVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateApp(Amazon.OpsWorks.Model.UpdateAppRequest)"> <summary> Updates a specified app. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateApp service method.</param> <returns>The response from the UpdateApp service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateAppAsync(Amazon.OpsWorks.Model.UpdateAppRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateApp operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateApp operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateElasticIp(Amazon.OpsWorks.Model.UpdateElasticIpRequest)"> <summary> Updates a registered Elastic IP address's name. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateElasticIp service method.</param> <returns>The response from the UpdateElasticIp service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateElasticIpAsync(Amazon.OpsWorks.Model.UpdateElasticIpRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateElasticIp operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateElasticIp operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateInstance(Amazon.OpsWorks.Model.UpdateInstanceRequest)"> <summary> Updates a specified instance. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateInstance service method.</param> <returns>The response from the UpdateInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateInstanceAsync(Amazon.OpsWorks.Model.UpdateInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateLayer(Amazon.OpsWorks.Model.UpdateLayerRequest)"> <summary> Updates a specified layer. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateLayer service method.</param> <returns>The response from the UpdateLayer service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateLayerAsync(Amazon.OpsWorks.Model.UpdateLayerRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateLayer operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateLayer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateMyUserProfile"> <summary> Updates a user's SSH public key. <para> <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <returns>The response from the UpdateMyUserProfile service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateMyUserProfile(Amazon.OpsWorks.Model.UpdateMyUserProfileRequest)"> <summary> Updates a user's SSH public key. <para> <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateMyUserProfile service method.</param> <returns>The response from the UpdateMyUserProfile service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateMyUserProfileAsync(Amazon.OpsWorks.Model.UpdateMyUserProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateMyUserProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateMyUserProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateRdsDbInstance(Amazon.OpsWorks.Model.UpdateRdsDbInstanceRequest)"> <summary> Updates an Amazon RDS instance. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateRdsDbInstance service method.</param> <returns>The response from the UpdateRdsDbInstance service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateRdsDbInstanceAsync(Amazon.OpsWorks.Model.UpdateRdsDbInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateRdsDbInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRdsDbInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateStack(Amazon.OpsWorks.Model.UpdateStackRequest)"> <summary> Updates a specified stack. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateStack service method.</param> <returns>The response from the UpdateStack service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateStackAsync(Amazon.OpsWorks.Model.UpdateStackRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateStack operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStack operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateUserProfile(Amazon.OpsWorks.Model.UpdateUserProfileRequest)"> <summary> Updates a specified user profile. <para> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateUserProfile service method.</param> <returns>The response from the UpdateUserProfile service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateUserProfileAsync(Amazon.OpsWorks.Model.UpdateUserProfileRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateUserProfile operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateUserProfile operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateVolume(Amazon.OpsWorks.Model.UpdateVolumeRequest)"> <summary> Updates an Amazon EBS volume's name or mount point. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateVolume service method.</param> <returns>The response from the UpdateVolume service method, as returned by OpsWorks.</returns> <exception cref="T:Amazon.OpsWorks.Model.ResourceNotFoundException"> Indicates that a resource was not found. </exception> <exception cref="T:Amazon.OpsWorks.Model.ValidationException"> Indicates that a request was invalid. </exception> </member> <member name="M:Amazon.OpsWorks.AmazonOpsWorksClient.UpdateVolumeAsync(Amazon.OpsWorks.Model.UpdateVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.RDS.AmazonRDSClient"> <summary> Implementation for accessing RDS Amazon Relational Database Service <para> Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique. </para> <para> Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Aurora database server. This means the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use. </para> <para> This is an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. For a summary of the Amazon RDS interfaces, go to <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html#Welcome.Interfaces">Available RDS Interfaces</a>. </para> </summary> </member> <member name="T:Amazon.RDS.IAmazonRDS"> <summary> Interface for accessing RDS Amazon Relational Database Service <para> Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique. </para> <para> Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Aurora database server. This means the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use. </para> <para> This is an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. For a summary of the Amazon RDS interfaces, go to <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html#Welcome.Interfaces">Available RDS Interfaces</a>. </para> </summary> </member> <member name="M:Amazon.RDS.IAmazonRDS.AddSourceIdentifierToSubscription(Amazon.RDS.Model.AddSourceIdentifierToSubscriptionRequest)"> <summary> Adds a source identifier to an existing RDS event notification subscription. </summary> <param name="request">Container for the necessary parameters to execute the AddSourceIdentifierToSubscription service method.</param> <returns>The response from the AddSourceIdentifierToSubscription service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.SourceNotFoundException"> The requested source could not be found. </exception> <exception cref="T:Amazon.RDS.Model.SubscriptionNotFoundException"> The subscription name does not exist. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.AddSourceIdentifierToSubscriptionAsync(Amazon.RDS.Model.AddSourceIdentifierToSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddSourceIdentifierToSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the AddSourceIdentifierToSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.AddTagsToResource(Amazon.RDS.Model.AddTagsToResourceRequest)"> <summary> Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS. <para> For an overview on tagging Amazon RDS resources, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html">Tagging Amazon RDS Resources</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToResource service method.</param> <returns>The response from the AddTagsToResource service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.AddTagsToResourceAsync(Amazon.RDS.Model.AddTagsToResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTagsToResource operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.ApplyPendingMaintenanceAction(Amazon.RDS.Model.ApplyPendingMaintenanceActionRequest)"> <summary> Applies a pending maintenance action to a resource (for example, to a DB instance). </summary> <param name="request">Container for the necessary parameters to execute the ApplyPendingMaintenanceAction service method.</param> <returns>The response from the ApplyPendingMaintenanceAction service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.ResourceNotFoundException"> The specified resource ID was not found. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.ApplyPendingMaintenanceActionAsync(Amazon.RDS.Model.ApplyPendingMaintenanceActionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ApplyPendingMaintenanceAction operation. </summary> <param name="request">Container for the necessary parameters to execute the ApplyPendingMaintenanceAction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.AuthorizeDBSecurityGroupIngress(Amazon.RDS.Model.AuthorizeDBSecurityGroupIngressRequest)"> <summary> Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). <note> You cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another. </note> <para> For an overview of CIDR ranges, go to the <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Wikipedia Tutorial</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeDBSecurityGroupIngress service method.</param> <returns>The response from the AuthorizeDBSecurityGroupIngress service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.AuthorizationAlreadyExistsException"> The specified CIDRIP or EC2 security group is already authorized for the specified DB security group. </exception> <exception cref="T:Amazon.RDS.Model.AuthorizationQuotaExceededException"> DB security group authorization quota has been reached. </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSecurityGroupStateException"> The state of the DB security group does not allow deletion. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.AuthorizeDBSecurityGroupIngressAsync(Amazon.RDS.Model.AuthorizeDBSecurityGroupIngressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AuthorizeDBSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeDBSecurityGroupIngress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.CopyDBClusterSnapshot(Amazon.RDS.Model.CopyDBClusterSnapshotRequest)"> <summary> Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </summary> <param name="request">Container for the necessary parameters to execute the CopyDBClusterSnapshot service method.</param> <returns>The response from the CopyDBClusterSnapshot service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterSnapshotAlreadyExistsException"> User already has a DB cluster snapshot with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterSnapshotNotFoundException"> <i>DBClusterSnapshotIdentifier</i> does not refer to an existing DB cluster snapshot. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterStateException"> The supplied value is not a valid DB cluster state. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.CopyDBClusterSnapshotAsync(Amazon.RDS.Model.CopyDBClusterSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopyDBClusterSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyDBClusterSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.CopyDBParameterGroup(Amazon.RDS.Model.CopyDBParameterGroupRequest)"> <summary> Copies the specified DB parameter group. </summary> <param name="request">Container for the necessary parameters to execute the CopyDBParameterGroup service method.</param> <returns>The response from the CopyDBParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupAlreadyExistsException"> A DB parameter group with the same name exists. </exception> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.DBParameterGroupQuotaExceededException"> Request would result in user exceeding the allowed number of DB parameter groups. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.CopyDBParameterGroupAsync(Amazon.RDS.Model.CopyDBParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopyDBParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyDBParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.CopyDBSnapshot(Amazon.RDS.Model.CopyDBSnapshotRequest)"> <summary> Copies the specified DBSnapshot. The source DB snapshot must be in the "available" state. <para> If you are copying from a shared manual DB snapshot, the <code>SourceDBSnapshotIdentifier</code> must be the ARN of the shared DB snapshot. </para> </summary> <param name="request">Container for the necessary parameters to execute the CopyDBSnapshot service method.</param> <returns>The response from the CopyDBSnapshot service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSnapshotAlreadyExistsException"> <i>DBSnapshotIdentifier</i> is already used by an existing snapshot. </exception> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSnapshotStateException"> The state of the DB snapshot does not allow deletion. </exception> <exception cref="T:Amazon.RDS.Model.SnapshotQuotaExceededException"> Request would result in user exceeding the allowed number of DB snapshots. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.CopyDBSnapshotAsync(Amazon.RDS.Model.CopyDBSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopyDBSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyDBSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.CopyOptionGroup(Amazon.RDS.Model.CopyOptionGroupRequest)"> <summary> Copies the specified option group. </summary> <param name="request">Container for the necessary parameters to execute the CopyOptionGroup service method.</param> <returns>The response from the CopyOptionGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.OptionGroupAlreadyExistsException"> The option group you are trying to create already exists. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupQuotaExceededException"> The quota of 20 option groups was exceeded for this AWS account. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.CopyOptionGroupAsync(Amazon.RDS.Model.CopyOptionGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopyOptionGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyOptionGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBCluster(Amazon.RDS.Model.CreateDBClusterRequest)"> <summary> Creates a new Amazon Aurora DB cluster. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </summary> <param name="request">Container for the necessary parameters to execute the CreateDBCluster service method.</param> <returns>The response from the CreateDBCluster service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterAlreadyExistsException"> User already has a DB cluster with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterParameterGroupNotFoundException"> <i>DBClusterParameterGroupName</i> does not refer to an existing DB Cluster parameter group. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterQuotaExceededException"> User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientStorageClusterCapacityException"> There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterStateException"> The supplied value is not a valid DB cluster state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSubnetGroupStateException"> The DB subnet group cannot be deleted because it is in use. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.KMSKeyNotAccessibleException"> Error accessing KMS key. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBClusterAsync(Amazon.RDS.Model.CreateDBClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBClusterParameterGroup(Amazon.RDS.Model.CreateDBClusterParameterGroupRequest)"> <summary> Creates a new DB cluster parameter group. <para> Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. </para> <para> A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using <a>ModifyDBClusterParameterGroup</a>. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using <a>ModifyDBCluster</a>. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. </para> <important> <para> After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <a>DescribeDBClusterParameters</a> command to verify that your DB cluster parameter group has been created or modified. </para> </important> <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDBClusterParameterGroup service method.</param> <returns>The response from the CreateDBClusterParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupAlreadyExistsException"> A DB parameter group with the same name exists. </exception> <exception cref="T:Amazon.RDS.Model.DBParameterGroupQuotaExceededException"> Request would result in user exceeding the allowed number of DB parameter groups. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBClusterParameterGroupAsync(Amazon.RDS.Model.CreateDBClusterParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBClusterParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBClusterParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBClusterSnapshot(Amazon.RDS.Model.CreateDBClusterSnapshotRequest)"> <summary> Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </summary> <param name="request">Container for the necessary parameters to execute the CreateDBClusterSnapshot service method.</param> <returns>The response from the CreateDBClusterSnapshot service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterNotFoundException"> <i>DBClusterIdentifier</i> does not refer to an existing DB cluster. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterSnapshotAlreadyExistsException"> User already has a DB cluster snapshot with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterStateException"> The supplied value is not a valid DB cluster state. </exception> <exception cref="T:Amazon.RDS.Model.SnapshotQuotaExceededException"> Request would result in user exceeding the allowed number of DB snapshots. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBClusterSnapshotAsync(Amazon.RDS.Model.CreateDBClusterSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBClusterSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBClusterSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBInstance(Amazon.RDS.Model.CreateDBInstanceRequest)"> <summary> Creates a new DB instance. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBInstance service method.</param> <returns>The response from the CreateDBInstance service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.AuthorizationNotFoundException"> Specified CIDRIP or EC2 security group is not authorized for the specified DB security group. <para> RDS may not also be authorized via IAM to perform necessary actions on your behalf. </para> </exception> <exception cref="T:Amazon.RDS.Model.DBClusterNotFoundException"> <i>DBClusterIdentifier</i> does not refer to an existing DB cluster. </exception> <exception cref="T:Amazon.RDS.Model.DBInstanceAlreadyExistsException"> User already has a DB instance with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupDoesNotCoverEnoughAZsException"> Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InstanceQuotaExceededException"> Request would result in user exceeding the allowed number of DB instances. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientDBInstanceCapacityException"> Specified DB instance class is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterStateException"> The supplied value is not a valid DB cluster state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.KMSKeyNotAccessibleException"> Error accessing KMS key. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> <exception cref="T:Amazon.RDS.Model.ProvisionedIopsNotAvailableInAZException"> Provisioned IOPS not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> <exception cref="T:Amazon.RDS.Model.StorageTypeNotSupportedException"> <i>StorageType</i> specified cannot be associated with the DB Instance. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBInstanceAsync(Amazon.RDS.Model.CreateDBInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBInstanceReadReplica(Amazon.RDS.Model.CreateDBInstanceReadReplicaRequest)"> <summary> Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance. <para> All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below. </para> <important> <para> The source DB instance must have backup retention enabled. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the CreateDBInstanceReadReplica service method.</param> <returns>The response from the CreateDBInstanceReadReplica service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceAlreadyExistsException"> User already has a DB instance with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupDoesNotCoverEnoughAZsException"> Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotAllowedException"> Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InstanceQuotaExceededException"> Request would result in user exceeding the allowed number of DB instances. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientDBInstanceCapacityException"> Specified DB instance class is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBInstanceStateException"> The specified DB instance is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSubnetGroupException"> Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.KMSKeyNotAccessibleException"> Error accessing KMS key. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> <exception cref="T:Amazon.RDS.Model.ProvisionedIopsNotAvailableInAZException"> Provisioned IOPS not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> <exception cref="T:Amazon.RDS.Model.StorageTypeNotSupportedException"> <i>StorageType</i> specified cannot be associated with the DB Instance. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBInstanceReadReplicaAsync(Amazon.RDS.Model.CreateDBInstanceReadReplicaRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBInstanceReadReplica operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBInstanceReadReplica operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBParameterGroup(Amazon.RDS.Model.CreateDBParameterGroupRequest)"> <summary> Creates a new DB parameter group. <para> A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using <i>ModifyDBParameterGroup</i>. Once you've created a DB parameter group, you need to associate it with your DB instance using <i>ModifyDBInstance</i>. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. </para> <important> <para> After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the CreateDBParameterGroup service method.</param> <returns>The response from the CreateDBParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupAlreadyExistsException"> A DB parameter group with the same name exists. </exception> <exception cref="T:Amazon.RDS.Model.DBParameterGroupQuotaExceededException"> Request would result in user exceeding the allowed number of DB parameter groups. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBParameterGroupAsync(Amazon.RDS.Model.CreateDBParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBSecurityGroup(Amazon.RDS.Model.CreateDBSecurityGroupRequest)"> <summary> Creates a new DB security group. DB security groups control access to a DB instance. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBSecurityGroup service method.</param> <returns>The response from the CreateDBSecurityGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupAlreadyExistsException"> A DB security group with the name specified in <i>DBSecurityGroupName</i> already exists. </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotSupportedException"> A DB security group is not allowed for this action. </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupQuotaExceededException"> Request would result in user exceeding the allowed number of DB security groups. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBSecurityGroupAsync(Amazon.RDS.Model.CreateDBSecurityGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBSecurityGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBSnapshot(Amazon.RDS.Model.CreateDBSnapshotRequest)"> <summary> Creates a DBSnapshot. The source DBInstance must be in "available" state. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBSnapshot service method.</param> <returns>The response from the CreateDBSnapshot service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBSnapshotAlreadyExistsException"> <i>DBSnapshotIdentifier</i> is already used by an existing snapshot. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBInstanceStateException"> The specified DB instance is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.RDS.Model.SnapshotQuotaExceededException"> Request would result in user exceeding the allowed number of DB snapshots. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBSnapshotAsync(Amazon.RDS.Model.CreateDBSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBSubnetGroup(Amazon.RDS.Model.CreateDBSubnetGroupRequest)"> <summary> Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBSubnetGroup service method.</param> <returns>The response from the CreateDBSubnetGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupAlreadyExistsException"> <i>DBSubnetGroupName</i> is already used by an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupDoesNotCoverEnoughAZsException"> Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupQuotaExceededException"> Request would result in user exceeding the allowed number of DB subnet groups. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetQuotaExceededException"> Request would result in user exceeding the allowed number of subnets in a DB subnet groups. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateDBSubnetGroupAsync(Amazon.RDS.Model.CreateDBSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateEventSubscription(Amazon.RDS.Model.CreateEventSubscriptionRequest)"> <summary> Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. <para> You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. </para> <para> If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateEventSubscription service method.</param> <returns>The response from the CreateEventSubscription service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.EventSubscriptionQuotaExceededException"> You have reached the maximum number of event subscriptions. </exception> <exception cref="T:Amazon.RDS.Model.SNSInvalidTopicException"> SNS has responded that there is a problem with the SND topic specified. </exception> <exception cref="T:Amazon.RDS.Model.SNSNoAuthorizationException"> You do not have permission to publish to the SNS topic ARN. </exception> <exception cref="T:Amazon.RDS.Model.SNSTopicArnNotFoundException"> The SNS topic ARN does not exist. </exception> <exception cref="T:Amazon.RDS.Model.SourceNotFoundException"> The requested source could not be found. </exception> <exception cref="T:Amazon.RDS.Model.SubscriptionAlreadyExistException"> The supplied subscription name already exists. </exception> <exception cref="T:Amazon.RDS.Model.SubscriptionCategoryNotFoundException"> The supplied category does not exist. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateEventSubscriptionAsync(Amazon.RDS.Model.CreateEventSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateEventSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateEventSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateOptionGroup(Amazon.RDS.Model.CreateOptionGroupRequest)"> <summary> Creates a new option group. You can create up to 20 option groups. </summary> <param name="request">Container for the necessary parameters to execute the CreateOptionGroup service method.</param> <returns>The response from the CreateOptionGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.OptionGroupAlreadyExistsException"> The option group you are trying to create already exists. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupQuotaExceededException"> The quota of 20 option groups was exceeded for this AWS account. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.CreateOptionGroupAsync(Amazon.RDS.Model.CreateOptionGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateOptionGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateOptionGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteDBCluster(Amazon.RDS.Model.DeleteDBClusterRequest)"> <summary> The DeleteDBCluster action deletes a previously provisioned DB cluster. A successful response from the web service indicates the request was received correctly. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the DB cluster to be deleted are not deleted. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBCluster service method.</param> <returns>The response from the DeleteDBCluster service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterNotFoundException"> <i>DBClusterIdentifier</i> does not refer to an existing DB cluster. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterStateException"> The supplied value is not a valid DB cluster state. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteDBClusterAsync(Amazon.RDS.Model.DeleteDBClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDBCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteDBClusterParameterGroup(Amazon.RDS.Model.DeleteDBClusterParameterGroupRequest)"> <summary> Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBClusterParameterGroup service method.</param> <returns>The response from the DeleteDBClusterParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBParameterGroupStateException"> The DB parameter group cannot be deleted because it is in use. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteDBClusterParameterGroupAsync(Amazon.RDS.Model.DeleteDBClusterParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDBClusterParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBClusterParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteDBClusterSnapshot(Amazon.RDS.Model.DeleteDBClusterSnapshotRequest)"> <summary> Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. <note>The DB cluster snapshot must be in the <code>available</code> state to be deleted.</note> <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBClusterSnapshot service method.</param> <returns>The response from the DeleteDBClusterSnapshot service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterSnapshotNotFoundException"> <i>DBClusterSnapshotIdentifier</i> does not refer to an existing DB cluster snapshot. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterSnapshotStateException"> The supplied value is not a valid DB cluster snapshot state. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteDBClusterSnapshotAsync(Amazon.RDS.Model.DeleteDBClusterSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDBClusterSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBClusterSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteDBInstance(Amazon.RDS.Model.DeleteDBInstanceRequest)"> <summary> The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted. <para> If a final DB snapshot is requested the status of the RDS instance will be "deleting" until the DB snapshot is created. The API action <code>DescribeDBInstance</code> is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted. </para> <para> Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true". </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBInstance service method.</param> <returns>The response from the DeleteDBInstance service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBSnapshotAlreadyExistsException"> <i>DBSnapshotIdentifier</i> is already used by an existing snapshot. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBInstanceStateException"> The specified DB instance is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.RDS.Model.SnapshotQuotaExceededException"> Request would result in user exceeding the allowed number of DB snapshots. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteDBInstanceAsync(Amazon.RDS.Model.DeleteDBInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDBInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteDBParameterGroup(Amazon.RDS.Model.DeleteDBParameterGroupRequest)"> <summary> Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBParameterGroup service method.</param> <returns>The response from the DeleteDBParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBParameterGroupStateException"> The DB parameter group cannot be deleted because it is in use. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteDBParameterGroupAsync(Amazon.RDS.Model.DeleteDBParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDBParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteDBSecurityGroup(Amazon.RDS.Model.DeleteDBSecurityGroupRequest)"> <summary> Deletes a DB security group. <note>The specified DB security group must not be associated with any DB instances.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBSecurityGroup service method.</param> <returns>The response from the DeleteDBSecurityGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSecurityGroupStateException"> The state of the DB security group does not allow deletion. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteDBSecurityGroupAsync(Amazon.RDS.Model.DeleteDBSecurityGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDBSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBSecurityGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteDBSnapshot(Amazon.RDS.Model.DeleteDBSnapshotRequest)"> <summary> Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated. <note>The DBSnapshot must be in the <code>available</code> state to be deleted.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBSnapshot service method.</param> <returns>The response from the DeleteDBSnapshot service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSnapshotStateException"> The state of the DB snapshot does not allow deletion. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteDBSnapshotAsync(Amazon.RDS.Model.DeleteDBSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDBSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteDBSubnetGroup(Amazon.RDS.Model.DeleteDBSubnetGroupRequest)"> <summary> Deletes a DB subnet group. <note>The specified database subnet group must not be associated with any DB instances.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBSubnetGroup service method.</param> <returns>The response from the DeleteDBSubnetGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSubnetGroupStateException"> The DB subnet group cannot be deleted because it is in use. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSubnetStateException"> The DB subnet is not in the <i>available</i> state. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteDBSubnetGroupAsync(Amazon.RDS.Model.DeleteDBSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDBSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteEventSubscription(Amazon.RDS.Model.DeleteEventSubscriptionRequest)"> <summary> Deletes an RDS event notification subscription. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEventSubscription service method.</param> <returns>The response from the DeleteEventSubscription service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.InvalidEventSubscriptionStateException"> This error can occur if someone else is modifying a subscription. You should retry the action. </exception> <exception cref="T:Amazon.RDS.Model.SubscriptionNotFoundException"> The subscription name does not exist. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteEventSubscriptionAsync(Amazon.RDS.Model.DeleteEventSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteEventSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEventSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteOptionGroup(Amazon.RDS.Model.DeleteOptionGroupRequest)"> <summary> Deletes an existing option group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteOptionGroup service method.</param> <returns>The response from the DeleteOptionGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.InvalidOptionGroupStateException"> The option group is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DeleteOptionGroupAsync(Amazon.RDS.Model.DeleteOptionGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteOptionGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteOptionGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeAccountAttributes"> <summary> Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. <para> This command does not take any parameters. </para> </summary> <returns>The response from the DescribeAccountAttributes service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeAccountAttributes(Amazon.RDS.Model.DescribeAccountAttributesRequest)"> <summary> Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. <para> This command does not take any parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountAttributes service method.</param> <returns>The response from the DescribeAccountAttributes service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeAccountAttributesAsync(Amazon.RDS.Model.DescribeAccountAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAccountAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeCertificates(Amazon.RDS.Model.DescribeCertificatesRequest)"> <summary> Lists the set of CA certificates provided by Amazon RDS for this AWS account. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCertificates service method.</param> <returns>The response from the DescribeCertificates service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.CertificateNotFoundException"> <i>CertificateIdentifier</i> does not refer to an existing certificate. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeCertificatesAsync(Amazon.RDS.Model.DescribeCertificatesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCertificates operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCertificates operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBClusterParameterGroups(Amazon.RDS.Model.DescribeDBClusterParameterGroupsRequest)"> <summary> Returns a list of <code>DBClusterParameterGroup</code> descriptions. If a <code>DBClusterParameterGroupName</code> parameter is specified, the list will contain only the description of the specified DB cluster parameter group. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBClusterParameterGroups service method.</param> <returns>The response from the DescribeDBClusterParameterGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBClusterParameterGroupsAsync(Amazon.RDS.Model.DescribeDBClusterParameterGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBClusterParameterGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBClusterParameterGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBClusterParameters(Amazon.RDS.Model.DescribeDBClusterParametersRequest)"> <summary> Returns the detailed parameter list for a particular DB cluster parameter group. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBClusterParameters service method.</param> <returns>The response from the DescribeDBClusterParameters service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBClusterParametersAsync(Amazon.RDS.Model.DescribeDBClusterParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBClusterParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBClusterParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBClusters(Amazon.RDS.Model.DescribeDBClustersRequest)"> <summary> Returns information about provisioned Aurora DB clusters. This API supports pagination. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBClusters service method.</param> <returns>The response from the DescribeDBClusters service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterNotFoundException"> <i>DBClusterIdentifier</i> does not refer to an existing DB cluster. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBClustersAsync(Amazon.RDS.Model.DescribeDBClustersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBClusters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBClusterSnapshots(Amazon.RDS.Model.DescribeDBClusterSnapshotsRequest)"> <summary> Returns information about DB cluster snapshots. This API supports pagination. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBClusterSnapshots service method.</param> <returns>The response from the DescribeDBClusterSnapshots service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterSnapshotNotFoundException"> <i>DBClusterSnapshotIdentifier</i> does not refer to an existing DB cluster snapshot. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBClusterSnapshotsAsync(Amazon.RDS.Model.DescribeDBClusterSnapshotsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBClusterSnapshots operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBClusterSnapshots operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBEngineVersions"> <summary> Returns a list of the available DB engines. </summary> <returns>The response from the DescribeDBEngineVersions service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBEngineVersions(Amazon.RDS.Model.DescribeDBEngineVersionsRequest)"> <summary> Returns a list of the available DB engines. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBEngineVersions service method.</param> <returns>The response from the DescribeDBEngineVersions service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBEngineVersionsAsync(Amazon.RDS.Model.DescribeDBEngineVersionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBEngineVersions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBEngineVersions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBInstances"> <summary> Returns information about provisioned RDS instances. This API supports pagination. </summary> <returns>The response from the DescribeDBInstances service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBInstances(Amazon.RDS.Model.DescribeDBInstancesRequest)"> <summary> Returns information about provisioned RDS instances. This API supports pagination. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBInstances service method.</param> <returns>The response from the DescribeDBInstances service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBInstancesAsync(Amazon.RDS.Model.DescribeDBInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBLogFiles(Amazon.RDS.Model.DescribeDBLogFilesRequest)"> <summary> Returns a list of DB log files for the DB instance. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBLogFiles service method.</param> <returns>The response from the DescribeDBLogFiles service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBLogFilesAsync(Amazon.RDS.Model.DescribeDBLogFilesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBLogFiles operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBLogFiles operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBParameterGroups"> <summary> Returns a list of <code>DBParameterGroup</code> descriptions. If a <code>DBParameterGroupName</code> is specified, the list will contain only the description of the specified DB parameter group. </summary> <returns>The response from the DescribeDBParameterGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBParameterGroups(Amazon.RDS.Model.DescribeDBParameterGroupsRequest)"> <summary> Returns a list of <code>DBParameterGroup</code> descriptions. If a <code>DBParameterGroupName</code> is specified, the list will contain only the description of the specified DB parameter group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBParameterGroups service method.</param> <returns>The response from the DescribeDBParameterGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBParameterGroupsAsync(Amazon.RDS.Model.DescribeDBParameterGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBParameterGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBParameterGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBParameters(Amazon.RDS.Model.DescribeDBParametersRequest)"> <summary> Returns the detailed parameter list for a particular DB parameter group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBParameters service method.</param> <returns>The response from the DescribeDBParameters service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBParametersAsync(Amazon.RDS.Model.DescribeDBParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBSecurityGroups"> <summary> Returns a list of <code>DBSecurityGroup</code> descriptions. If a <code>DBSecurityGroupName</code> is specified, the list will contain only the descriptions of the specified DB security group. </summary> <returns>The response from the DescribeDBSecurityGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBSecurityGroups(Amazon.RDS.Model.DescribeDBSecurityGroupsRequest)"> <summary> Returns a list of <code>DBSecurityGroup</code> descriptions. If a <code>DBSecurityGroupName</code> is specified, the list will contain only the descriptions of the specified DB security group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBSecurityGroups service method.</param> <returns>The response from the DescribeDBSecurityGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBSecurityGroupsAsync(Amazon.RDS.Model.DescribeDBSecurityGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBSecurityGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBSecurityGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBSnapshotAttributes(Amazon.RDS.Model.DescribeDBSnapshotAttributesRequest)"> <summary> Returns a list of DB snapshot attribute names and values for a manual DB snapshot. <para> When sharing snapshots with other AWS accounts, <code>DescribeDBSnapshotAttributes</code> returns the <code>restore</code> attribute and a list of the AWS account ids that are authorized to copy or restore the manual DB snapshot. If <code>all</code> is included in the list of values for the <code>restore</code> attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts. </para> <para> To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the <a>ModifyDBSnapshotAttribute</a> API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBSnapshotAttributes service method.</param> <returns>The response from the DescribeDBSnapshotAttributes service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBSnapshotAttributesAsync(Amazon.RDS.Model.DescribeDBSnapshotAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBSnapshotAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBSnapshotAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBSnapshots"> <summary> Returns information about DB snapshots. This API supports pagination. </summary> <returns>The response from the DescribeDBSnapshots service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBSnapshots(Amazon.RDS.Model.DescribeDBSnapshotsRequest)"> <summary> Returns information about DB snapshots. This API supports pagination. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBSnapshots service method.</param> <returns>The response from the DescribeDBSnapshots service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBSnapshotsAsync(Amazon.RDS.Model.DescribeDBSnapshotsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBSnapshots operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBSnapshots operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBSubnetGroups"> <summary> Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. <para> For an overview of CIDR ranges, go to the <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Wikipedia Tutorial</a>. </para> </summary> <returns>The response from the DescribeDBSubnetGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBSubnetGroups(Amazon.RDS.Model.DescribeDBSubnetGroupsRequest)"> <summary> Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. <para> For an overview of CIDR ranges, go to the <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Wikipedia Tutorial</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBSubnetGroups service method.</param> <returns>The response from the DescribeDBSubnetGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeDBSubnetGroupsAsync(Amazon.RDS.Model.DescribeDBSubnetGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBSubnetGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBSubnetGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeEngineDefaultClusterParameters(Amazon.RDS.Model.DescribeEngineDefaultClusterParametersRequest)"> <summary> Returns the default engine and system parameter information for the cluster database engine. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEngineDefaultClusterParameters service method.</param> <returns>The response from the DescribeEngineDefaultClusterParameters service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeEngineDefaultClusterParametersAsync(Amazon.RDS.Model.DescribeEngineDefaultClusterParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEngineDefaultClusterParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEngineDefaultClusterParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeEngineDefaultParameters(Amazon.RDS.Model.DescribeEngineDefaultParametersRequest)"> <summary> Returns the default engine and system parameter information for the specified database engine. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEngineDefaultParameters service method.</param> <returns>The response from the DescribeEngineDefaultParameters service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeEngineDefaultParametersAsync(Amazon.RDS.Model.DescribeEngineDefaultParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEngineDefaultParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEngineDefaultParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeEventCategories"> <summary> Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html"> Events</a> topic in the <i>Amazon RDS User Guide.</i> </summary> <returns>The response from the DescribeEventCategories service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeEventCategories(Amazon.RDS.Model.DescribeEventCategoriesRequest)"> <summary> Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html"> Events</a> topic in the <i>Amazon RDS User Guide.</i> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventCategories service method.</param> <returns>The response from the DescribeEventCategories service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeEventCategoriesAsync(Amazon.RDS.Model.DescribeEventCategoriesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEventCategories operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventCategories operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeEvents"> <summary> Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. </summary> <returns>The response from the DescribeEvents service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeEvents(Amazon.RDS.Model.DescribeEventsRequest)"> <summary> Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents service method.</param> <returns>The response from the DescribeEvents service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeEventsAsync(Amazon.RDS.Model.DescribeEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeEventSubscriptions"> <summary> Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. <para> If you specify a SubscriptionName, lists the description for that subscription. </para> </summary> <returns>The response from the DescribeEventSubscriptions service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.SubscriptionNotFoundException"> The subscription name does not exist. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeEventSubscriptions(Amazon.RDS.Model.DescribeEventSubscriptionsRequest)"> <summary> Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. <para> If you specify a SubscriptionName, lists the description for that subscription. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventSubscriptions service method.</param> <returns>The response from the DescribeEventSubscriptions service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.SubscriptionNotFoundException"> The subscription name does not exist. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeEventSubscriptionsAsync(Amazon.RDS.Model.DescribeEventSubscriptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEventSubscriptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventSubscriptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeOptionGroupOptions(Amazon.RDS.Model.DescribeOptionGroupOptionsRequest)"> <summary> Describes all available options. </summary> <param name="request">Container for the necessary parameters to execute the DescribeOptionGroupOptions service method.</param> <returns>The response from the DescribeOptionGroupOptions service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeOptionGroupOptionsAsync(Amazon.RDS.Model.DescribeOptionGroupOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeOptionGroupOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeOptionGroupOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeOptionGroups"> <summary> Describes the available option groups. </summary> <returns>The response from the DescribeOptionGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeOptionGroups(Amazon.RDS.Model.DescribeOptionGroupsRequest)"> <summary> Describes the available option groups. </summary> <param name="request">Container for the necessary parameters to execute the DescribeOptionGroups service method.</param> <returns>The response from the DescribeOptionGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeOptionGroupsAsync(Amazon.RDS.Model.DescribeOptionGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeOptionGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeOptionGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeOrderableDBInstanceOptions(Amazon.RDS.Model.DescribeOrderableDBInstanceOptionsRequest)"> <summary> Returns a list of orderable DB instance options for the specified engine. </summary> <param name="request">Container for the necessary parameters to execute the DescribeOrderableDBInstanceOptions service method.</param> <returns>The response from the DescribeOrderableDBInstanceOptions service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeOrderableDBInstanceOptionsAsync(Amazon.RDS.Model.DescribeOrderableDBInstanceOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeOrderableDBInstanceOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeOrderableDBInstanceOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribePendingMaintenanceActions(Amazon.RDS.Model.DescribePendingMaintenanceActionsRequest)"> <summary> Returns a list of resources (for example, DB instances) that have at least one pending maintenance action. </summary> <param name="request">Container for the necessary parameters to execute the DescribePendingMaintenanceActions service method.</param> <returns>The response from the DescribePendingMaintenanceActions service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.ResourceNotFoundException"> The specified resource ID was not found. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribePendingMaintenanceActionsAsync(Amazon.RDS.Model.DescribePendingMaintenanceActionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribePendingMaintenanceActions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePendingMaintenanceActions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeReservedDBInstances"> <summary> Returns information about reserved DB instances for this account, or about a specified reserved DB instance. </summary> <returns>The response from the DescribeReservedDBInstances service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.ReservedDBInstanceNotFoundException"> The specified reserved DB Instance not found. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeReservedDBInstances(Amazon.RDS.Model.DescribeReservedDBInstancesRequest)"> <summary> Returns information about reserved DB instances for this account, or about a specified reserved DB instance. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedDBInstances service method.</param> <returns>The response from the DescribeReservedDBInstances service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.ReservedDBInstanceNotFoundException"> The specified reserved DB Instance not found. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeReservedDBInstancesAsync(Amazon.RDS.Model.DescribeReservedDBInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedDBInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedDBInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeReservedDBInstancesOfferings"> <summary> Lists available reserved DB instance offerings. </summary> <returns>The response from the DescribeReservedDBInstancesOfferings service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.ReservedDBInstancesOfferingNotFoundException"> Specified offering does not exist. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeReservedDBInstancesOfferings(Amazon.RDS.Model.DescribeReservedDBInstancesOfferingsRequest)"> <summary> Lists available reserved DB instance offerings. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedDBInstancesOfferings service method.</param> <returns>The response from the DescribeReservedDBInstancesOfferings service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.ReservedDBInstancesOfferingNotFoundException"> Specified offering does not exist. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DescribeReservedDBInstancesOfferingsAsync(Amazon.RDS.Model.DescribeReservedDBInstancesOfferingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedDBInstancesOfferings operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedDBInstancesOfferings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.DownloadDBLogFilePortion(Amazon.RDS.Model.DownloadDBLogFilePortionRequest)"> <summary> Downloads all or a portion of the specified log file, up to 1 MB in size. </summary> <param name="request">Container for the necessary parameters to execute the DownloadDBLogFilePortion service method.</param> <returns>The response from the DownloadDBLogFilePortion service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBLogFileNotFoundException"> <i>LogFileName</i> does not refer to an existing DB log file. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.DownloadDBLogFilePortionAsync(Amazon.RDS.Model.DownloadDBLogFilePortionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DownloadDBLogFilePortion operation. </summary> <param name="request">Container for the necessary parameters to execute the DownloadDBLogFilePortion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.FailoverDBCluster(Amazon.RDS.Model.FailoverDBClusterRequest)"> <summary> Forces a failover for a DB cluster. <para> A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance. </para> <para> Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. </para> <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the FailoverDBCluster service method.</param> <returns>The response from the FailoverDBCluster service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterNotFoundException"> <i>DBClusterIdentifier</i> does not refer to an existing DB cluster. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterStateException"> The supplied value is not a valid DB cluster state. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.FailoverDBClusterAsync(Amazon.RDS.Model.FailoverDBClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the FailoverDBCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the FailoverDBCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.ListTagsForResource(Amazon.RDS.Model.ListTagsForResourceRequest)"> <summary> Lists all tags on an Amazon RDS resource. <para> For an overview on tagging an Amazon RDS resource, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html">Tagging Amazon RDS Resources</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResource service method.</param> <returns>The response from the ListTagsForResource service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.ListTagsForResourceAsync(Amazon.RDS.Model.ListTagsForResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTagsForResource operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.ModifyDBCluster(Amazon.RDS.Model.ModifyDBClusterRequest)"> <summary> Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBCluster service method.</param> <returns>The response from the ModifyDBCluster service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterAlreadyExistsException"> User already has a DB cluster with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterNotFoundException"> <i>DBClusterIdentifier</i> does not refer to an existing DB cluster. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterParameterGroupNotFoundException"> <i>DBClusterParameterGroupName</i> does not refer to an existing DB Cluster parameter group. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterStateException"> The supplied value is not a valid DB cluster state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBInstanceStateException"> The specified DB instance is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSecurityGroupStateException"> The state of the DB security group does not allow deletion. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSubnetGroupStateException"> The DB subnet group cannot be deleted because it is in use. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.ModifyDBClusterAsync(Amazon.RDS.Model.ModifyDBClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyDBCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.ModifyDBClusterParameterGroup(Amazon.RDS.Model.ModifyDBClusterParameterGroupRequest)"> <summary> Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> <note> <para> Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect. </para> </note> <important> <para> After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <a>DescribeDBClusterParameters</a> command to verify that your DB cluster parameter group has been created or modified. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBClusterParameterGroup service method.</param> <returns>The response from the ModifyDBClusterParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBParameterGroupStateException"> The DB parameter group cannot be deleted because it is in use. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.ModifyDBClusterParameterGroupAsync(Amazon.RDS.Model.ModifyDBClusterParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyDBClusterParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBClusterParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.ModifyDBInstance(Amazon.RDS.Model.ModifyDBInstanceRequest)"> <summary> Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBInstance service method.</param> <returns>The response from the ModifyDBInstance service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.AuthorizationNotFoundException"> Specified CIDRIP or EC2 security group is not authorized for the specified DB security group. <para> RDS may not also be authorized via IAM to perform necessary actions on your behalf. </para> </exception> <exception cref="T:Amazon.RDS.Model.CertificateNotFoundException"> <i>CertificateIdentifier</i> does not refer to an existing certificate. </exception> <exception cref="T:Amazon.RDS.Model.DBInstanceAlreadyExistsException"> User already has a DB instance with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> <exception cref="T:Amazon.RDS.Model.DBUpgradeDependencyFailureException"> The DB upgrade failed because a resource the DB depends on could not be modified. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientDBInstanceCapacityException"> Specified DB instance class is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBInstanceStateException"> The specified DB instance is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSecurityGroupStateException"> The state of the DB security group does not allow deletion. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> <exception cref="T:Amazon.RDS.Model.ProvisionedIopsNotAvailableInAZException"> Provisioned IOPS not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> <exception cref="T:Amazon.RDS.Model.StorageTypeNotSupportedException"> <i>StorageType</i> specified cannot be associated with the DB Instance. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.ModifyDBInstanceAsync(Amazon.RDS.Model.ModifyDBInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyDBInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.ModifyDBParameterGroup(Amazon.RDS.Model.ModifyDBParameterGroupRequest)"> <summary> Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. <note> <para> Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect. </para> </note> <important> <para> After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBParameterGroup service method.</param> <returns>The response from the ModifyDBParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBParameterGroupStateException"> The DB parameter group cannot be deleted because it is in use. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.ModifyDBParameterGroupAsync(Amazon.RDS.Model.ModifyDBParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyDBParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.ModifyDBSnapshotAttribute(Amazon.RDS.Model.ModifyDBSnapshotAttributeRequest)"> <summary> Adds an attribute and values to, or removes an attribute and values from a manual DB snapshot. <para> To share a manual DB snapshot with other AWS accounts, specify <code>restore</code> as the <code>AttributeName</code> and use the <code>ValuesToAdd</code> parameter to add a list of the AWS account ids that are authorized to retore the manual DB snapshot. Uses the value <code>all</code> to make the manual DB snapshot public and can by copied or restored by all AWS accounts. Do not add the <code>all</code> value for any manual DB snapshots that contain private information that you do not want to be available to all AWS accounts. </para> <para> To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the <a>DescribeDBSnapshotAttributes</a> API. </para> <para> If the manual DB snapshot is encrypted, it cannot be shared. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBSnapshotAttribute service method.</param> <returns>The response from the ModifyDBSnapshotAttribute service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSnapshotStateException"> The state of the DB snapshot does not allow deletion. </exception> <exception cref="T:Amazon.RDS.Model.SharedSnapshotQuotaExceededException"> You have exceeded the maximum number of account ids that you can share a manual DB snapshot with. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.ModifyDBSnapshotAttributeAsync(Amazon.RDS.Model.ModifyDBSnapshotAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyDBSnapshotAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBSnapshotAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.ModifyDBSubnetGroup(Amazon.RDS.Model.ModifyDBSubnetGroupRequest)"> <summary> Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region. </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBSubnetGroup service method.</param> <returns>The response from the ModifyDBSubnetGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupDoesNotCoverEnoughAZsException"> Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetQuotaExceededException"> Request would result in user exceeding the allowed number of subnets in a DB subnet groups. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.SubnetAlreadyInUseException"> The DB subnet is already in use in the Availability Zone. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.ModifyDBSubnetGroupAsync(Amazon.RDS.Model.ModifyDBSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyDBSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.ModifyEventSubscription(Amazon.RDS.Model.ModifyEventSubscriptionRequest)"> <summary> Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the <a>AddSourceIdentifierToSubscription</a> and <a>RemoveSourceIdentifierFromSubscription</a> calls. <para> You can see a list of the event categories for a given SourceType in the <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html">Events</a> topic in the Amazon RDS User Guide or by using the <b>DescribeEventCategories</b> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyEventSubscription service method.</param> <returns>The response from the ModifyEventSubscription service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.EventSubscriptionQuotaExceededException"> You have reached the maximum number of event subscriptions. </exception> <exception cref="T:Amazon.RDS.Model.SNSInvalidTopicException"> SNS has responded that there is a problem with the SND topic specified. </exception> <exception cref="T:Amazon.RDS.Model.SNSNoAuthorizationException"> You do not have permission to publish to the SNS topic ARN. </exception> <exception cref="T:Amazon.RDS.Model.SNSTopicArnNotFoundException"> The SNS topic ARN does not exist. </exception> <exception cref="T:Amazon.RDS.Model.SubscriptionCategoryNotFoundException"> The supplied category does not exist. </exception> <exception cref="T:Amazon.RDS.Model.SubscriptionNotFoundException"> The subscription name does not exist. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.ModifyEventSubscriptionAsync(Amazon.RDS.Model.ModifyEventSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyEventSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyEventSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.ModifyOptionGroup(Amazon.RDS.Model.ModifyOptionGroupRequest)"> <summary> Modifies an existing option group. </summary> <param name="request">Container for the necessary parameters to execute the ModifyOptionGroup service method.</param> <returns>The response from the ModifyOptionGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.InvalidOptionGroupStateException"> The option group is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.ModifyOptionGroupAsync(Amazon.RDS.Model.ModifyOptionGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyOptionGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyOptionGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.PromoteReadReplica(Amazon.RDS.Model.PromoteReadReplicaRequest)"> <summary> Promotes a Read Replica DB instance to a standalone DB instance. <note> <para> We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the PromoteReadReplica service method.</param> <returns>The response from the PromoteReadReplica service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBInstanceStateException"> The specified DB instance is not in the <i>available</i> state. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.PromoteReadReplicaAsync(Amazon.RDS.Model.PromoteReadReplicaRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PromoteReadReplica operation. </summary> <param name="request">Container for the necessary parameters to execute the PromoteReadReplica operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.PurchaseReservedDBInstancesOffering(Amazon.RDS.Model.PurchaseReservedDBInstancesOfferingRequest)"> <summary> Purchases a reserved DB instance offering. </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedDBInstancesOffering service method.</param> <returns>The response from the PurchaseReservedDBInstancesOffering service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.ReservedDBInstanceAlreadyExistsException"> User already has a reservation with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.ReservedDBInstanceQuotaExceededException"> Request would exceed the user's DB Instance quota. </exception> <exception cref="T:Amazon.RDS.Model.ReservedDBInstancesOfferingNotFoundException"> Specified offering does not exist. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.PurchaseReservedDBInstancesOfferingAsync(Amazon.RDS.Model.PurchaseReservedDBInstancesOfferingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PurchaseReservedDBInstancesOffering operation. </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedDBInstancesOffering operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.RebootDBInstance(Amazon.RDS.Model.RebootDBInstanceRequest)"> <summary> Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed. <para> If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs. </para> <para> The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions. </para> </summary> <param name="request">Container for the necessary parameters to execute the RebootDBInstance service method.</param> <returns>The response from the RebootDBInstance service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBInstanceStateException"> The specified DB instance is not in the <i>available</i> state. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.RebootDBInstanceAsync(Amazon.RDS.Model.RebootDBInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RebootDBInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the RebootDBInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.RemoveSourceIdentifierFromSubscription(Amazon.RDS.Model.RemoveSourceIdentifierFromSubscriptionRequest)"> <summary> Removes a source identifier from an existing RDS event notification subscription. </summary> <param name="request">Container for the necessary parameters to execute the RemoveSourceIdentifierFromSubscription service method.</param> <returns>The response from the RemoveSourceIdentifierFromSubscription service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.SourceNotFoundException"> The requested source could not be found. </exception> <exception cref="T:Amazon.RDS.Model.SubscriptionNotFoundException"> The subscription name does not exist. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.RemoveSourceIdentifierFromSubscriptionAsync(Amazon.RDS.Model.RemoveSourceIdentifierFromSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveSourceIdentifierFromSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveSourceIdentifierFromSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.RemoveTagsFromResource(Amazon.RDS.Model.RemoveTagsFromResourceRequest)"> <summary> Removes metadata tags from an Amazon RDS resource. <para> For an overview on tagging an Amazon RDS resource, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html">Tagging Amazon RDS Resources</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromResource service method.</param> <returns>The response from the RemoveTagsFromResource service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.RemoveTagsFromResourceAsync(Amazon.RDS.Model.RemoveTagsFromResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTagsFromResource operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.ResetDBClusterParameterGroup(Amazon.RDS.Model.ResetDBClusterParameterGroupRequest)"> <summary> Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire DB cluster parameter group, specify the <code>DBClusterParameterGroupName</code> and <code>ResetAllParameters</code> parameters. <para> When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance restart or <a>RebootDBInstance</a> request. You must call <a>RebootDBInstance</a> for every DB instance in your DB cluster that you want the updated static parameter to apply to. </para> <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the ResetDBClusterParameterGroup service method.</param> <returns>The response from the ResetDBClusterParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBParameterGroupStateException"> The DB parameter group cannot be deleted because it is in use. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.ResetDBClusterParameterGroupAsync(Amazon.RDS.Model.ResetDBClusterParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetDBClusterParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetDBClusterParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.ResetDBParameterGroup(Amazon.RDS.Model.ResetDBParameterGroupRequest)"> <summary> Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire DB parameter group, specify the <code>DBParameterGroup</code> name and <code>ResetAllParameters</code> parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance restart or <code>RebootDBInstance</code> request. </summary> <param name="request">Container for the necessary parameters to execute the ResetDBParameterGroup service method.</param> <returns>The response from the ResetDBParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBParameterGroupStateException"> The DB parameter group cannot be deleted because it is in use. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.ResetDBParameterGroupAsync(Amazon.RDS.Model.ResetDBParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetDBParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetDBParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.RestoreDBClusterFromSnapshot(Amazon.RDS.Model.RestoreDBClusterFromSnapshotRequest)"> <summary> Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the RestoreDBClusterFromSnapshot service method.</param> <returns>The response from the RestoreDBClusterFromSnapshot service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterAlreadyExistsException"> User already has a DB cluster with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterQuotaExceededException"> User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterSnapshotNotFoundException"> <i>DBClusterSnapshotIdentifier</i> does not refer to an existing DB cluster snapshot. </exception> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientDBClusterCapacityException"> The DB cluster does not have enough capacity for the current operation. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientStorageClusterCapacityException"> There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterSnapshotStateException"> The supplied value is not a valid DB cluster snapshot state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSnapshotStateException"> The state of the DB snapshot does not allow deletion. </exception> <exception cref="T:Amazon.RDS.Model.InvalidRestoreException"> Cannot restore from vpc backup to non-vpc DB instance. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.KMSKeyNotAccessibleException"> Error accessing KMS key. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.RestoreDBClusterFromSnapshotAsync(Amazon.RDS.Model.RestoreDBClusterFromSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestoreDBClusterFromSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreDBClusterFromSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.RestoreDBClusterToPointInTime(Amazon.RDS.Model.RestoreDBClusterToPointInTimeRequest)"> <summary> Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before <code>LatestRestorableTime</code> for up to <code>BackupRetentionPeriod</code> days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the RestoreDBClusterToPointInTime service method.</param> <returns>The response from the RestoreDBClusterToPointInTime service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterAlreadyExistsException"> User already has a DB cluster with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterNotFoundException"> <i>DBClusterIdentifier</i> does not refer to an existing DB cluster. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterQuotaExceededException"> User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterSnapshotNotFoundException"> <i>DBClusterSnapshotIdentifier</i> does not refer to an existing DB cluster snapshot. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientDBClusterCapacityException"> The DB cluster does not have enough capacity for the current operation. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterSnapshotStateException"> The supplied value is not a valid DB cluster snapshot state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSnapshotStateException"> The state of the DB snapshot does not allow deletion. </exception> <exception cref="T:Amazon.RDS.Model.InvalidRestoreException"> Cannot restore from vpc backup to non-vpc DB instance. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.KMSKeyNotAccessibleException"> Error accessing KMS key. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.RestoreDBClusterToPointInTimeAsync(Amazon.RDS.Model.RestoreDBClusterToPointInTimeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestoreDBClusterToPointInTime operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreDBClusterToPointInTime operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.RestoreDBInstanceFromDBSnapshot(Amazon.RDS.Model.RestoreDBInstanceFromDBSnapshotRequest)"> <summary> Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment. <para> If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot. </para> <para> If you are restoring from a shared manual DB snapshot, the <code>DBSnapshotIdentifier</code> must be the ARN of the shared DB snapshot. </para> </summary> <param name="request">Container for the necessary parameters to execute the RestoreDBInstanceFromDBSnapshot service method.</param> <returns>The response from the RestoreDBInstanceFromDBSnapshot service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.AuthorizationNotFoundException"> Specified CIDRIP or EC2 security group is not authorized for the specified DB security group. <para> RDS may not also be authorized via IAM to perform necessary actions on your behalf. </para> </exception> <exception cref="T:Amazon.RDS.Model.DBInstanceAlreadyExistsException"> User already has a DB instance with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupDoesNotCoverEnoughAZsException"> Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InstanceQuotaExceededException"> Request would result in user exceeding the allowed number of DB instances. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientDBInstanceCapacityException"> Specified DB instance class is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSnapshotStateException"> The state of the DB snapshot does not allow deletion. </exception> <exception cref="T:Amazon.RDS.Model.InvalidRestoreException"> Cannot restore from vpc backup to non-vpc DB instance. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.KMSKeyNotAccessibleException"> Error accessing KMS key. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> <exception cref="T:Amazon.RDS.Model.ProvisionedIopsNotAvailableInAZException"> Provisioned IOPS not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> <exception cref="T:Amazon.RDS.Model.StorageTypeNotSupportedException"> <i>StorageType</i> specified cannot be associated with the DB Instance. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.RestoreDBInstanceFromDBSnapshotAsync(Amazon.RDS.Model.RestoreDBInstanceFromDBSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestoreDBInstanceFromDBSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreDBInstanceFromDBSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.RestoreDBInstanceToPointInTime(Amazon.RDS.Model.RestoreDBInstanceToPointInTimeRequest)"> <summary> Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property. <para> The target database is created with most of the original configuration, but in a system-selected availability zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment. </para> </summary> <param name="request">Container for the necessary parameters to execute the RestoreDBInstanceToPointInTime service method.</param> <returns>The response from the RestoreDBInstanceToPointInTime service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.AuthorizationNotFoundException"> Specified CIDRIP or EC2 security group is not authorized for the specified DB security group. <para> RDS may not also be authorized via IAM to perform necessary actions on your behalf. </para> </exception> <exception cref="T:Amazon.RDS.Model.DBInstanceAlreadyExistsException"> User already has a DB instance with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupDoesNotCoverEnoughAZsException"> Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InstanceQuotaExceededException"> Request would result in user exceeding the allowed number of DB instances. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientDBInstanceCapacityException"> Specified DB instance class is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBInstanceStateException"> The specified DB instance is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidRestoreException"> Cannot restore from vpc backup to non-vpc DB instance. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.KMSKeyNotAccessibleException"> Error accessing KMS key. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> <exception cref="T:Amazon.RDS.Model.PointInTimeRestoreNotEnabledException"> <i>SourceDBInstanceIdentifier</i> refers to a DB instance with <i>BackupRetentionPeriod</i> equal to 0. </exception> <exception cref="T:Amazon.RDS.Model.ProvisionedIopsNotAvailableInAZException"> Provisioned IOPS not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> <exception cref="T:Amazon.RDS.Model.StorageTypeNotSupportedException"> <i>StorageType</i> specified cannot be associated with the DB Instance. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.RestoreDBInstanceToPointInTimeAsync(Amazon.RDS.Model.RestoreDBInstanceToPointInTimeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestoreDBInstanceToPointInTime operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreDBInstanceToPointInTime operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.IAmazonRDS.RevokeDBSecurityGroupIngress(Amazon.RDS.Model.RevokeDBSecurityGroupIngressRequest)"> <summary> Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId). </summary> <param name="request">Container for the necessary parameters to execute the RevokeDBSecurityGroupIngress service method.</param> <returns>The response from the RevokeDBSecurityGroupIngress service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.AuthorizationNotFoundException"> Specified CIDRIP or EC2 security group is not authorized for the specified DB security group. <para> RDS may not also be authorized via IAM to perform necessary actions on your behalf. </para> </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSecurityGroupStateException"> The state of the DB security group does not allow deletion. </exception> </member> <member name="M:Amazon.RDS.IAmazonRDS.RevokeDBSecurityGroupIngressAsync(Amazon.RDS.Model.RevokeDBSecurityGroupIngressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RevokeDBSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeDBSecurityGroupIngress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.#ctor"> <summary> Constructs AmazonRDSClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.RDS.AmazonRDSClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonRDSClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.RDS.AmazonRDSClient.#ctor(Amazon.RDS.AmazonRDSConfig)"> <summary> Constructs AmazonRDSClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonRDSClient Configuration Object</param> </member> <member name="M:Amazon.RDS.AmazonRDSClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonRDSClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.RDS.AmazonRDSClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonRDSClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.RDS.AmazonRDSClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RDS.AmazonRDSConfig)"> <summary> Constructs AmazonRDSClient with AWS Credentials and an AmazonRDSClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonRDSClient Configuration Object</param> </member> <member name="M:Amazon.RDS.AmazonRDSClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonRDSClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.RDS.AmazonRDSClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonRDSClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.RDS.AmazonRDSClient.#ctor(System.String,System.String,Amazon.RDS.AmazonRDSConfig)"> <summary> Constructs AmazonRDSClient with AWS Access Key ID, AWS Secret Key and an AmazonRDSClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonRDSClient Configuration Object</param> </member> <member name="M:Amazon.RDS.AmazonRDSClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonRDSClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.RDS.AmazonRDSClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonRDSClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.RDS.AmazonRDSClient.#ctor(System.String,System.String,System.String,Amazon.RDS.AmazonRDSConfig)"> <summary> Constructs AmazonRDSClient with AWS Access Key ID, AWS Secret Key and an AmazonRDSClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonRDSClient Configuration Object</param> </member> <member name="M:Amazon.RDS.AmazonRDSClient.AddSourceIdentifierToSubscription(Amazon.RDS.Model.AddSourceIdentifierToSubscriptionRequest)"> <summary> Adds a source identifier to an existing RDS event notification subscription. </summary> <param name="request">Container for the necessary parameters to execute the AddSourceIdentifierToSubscription service method.</param> <returns>The response from the AddSourceIdentifierToSubscription service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.SourceNotFoundException"> The requested source could not be found. </exception> <exception cref="T:Amazon.RDS.Model.SubscriptionNotFoundException"> The subscription name does not exist. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.AddSourceIdentifierToSubscriptionAsync(Amazon.RDS.Model.AddSourceIdentifierToSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddSourceIdentifierToSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the AddSourceIdentifierToSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.AddTagsToResource(Amazon.RDS.Model.AddTagsToResourceRequest)"> <summary> Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS. <para> For an overview on tagging Amazon RDS resources, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html">Tagging Amazon RDS Resources</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToResource service method.</param> <returns>The response from the AddTagsToResource service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.AddTagsToResourceAsync(Amazon.RDS.Model.AddTagsToResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTagsToResource operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ApplyPendingMaintenanceAction(Amazon.RDS.Model.ApplyPendingMaintenanceActionRequest)"> <summary> Applies a pending maintenance action to a resource (for example, to a DB instance). </summary> <param name="request">Container for the necessary parameters to execute the ApplyPendingMaintenanceAction service method.</param> <returns>The response from the ApplyPendingMaintenanceAction service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.ResourceNotFoundException"> The specified resource ID was not found. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ApplyPendingMaintenanceActionAsync(Amazon.RDS.Model.ApplyPendingMaintenanceActionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ApplyPendingMaintenanceAction operation. </summary> <param name="request">Container for the necessary parameters to execute the ApplyPendingMaintenanceAction operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.AuthorizeDBSecurityGroupIngress(Amazon.RDS.Model.AuthorizeDBSecurityGroupIngressRequest)"> <summary> Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). <note> You cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another. </note> <para> For an overview of CIDR ranges, go to the <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Wikipedia Tutorial</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeDBSecurityGroupIngress service method.</param> <returns>The response from the AuthorizeDBSecurityGroupIngress service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.AuthorizationAlreadyExistsException"> The specified CIDRIP or EC2 security group is already authorized for the specified DB security group. </exception> <exception cref="T:Amazon.RDS.Model.AuthorizationQuotaExceededException"> DB security group authorization quota has been reached. </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSecurityGroupStateException"> The state of the DB security group does not allow deletion. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.AuthorizeDBSecurityGroupIngressAsync(Amazon.RDS.Model.AuthorizeDBSecurityGroupIngressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AuthorizeDBSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeDBSecurityGroupIngress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CopyDBClusterSnapshot(Amazon.RDS.Model.CopyDBClusterSnapshotRequest)"> <summary> Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </summary> <param name="request">Container for the necessary parameters to execute the CopyDBClusterSnapshot service method.</param> <returns>The response from the CopyDBClusterSnapshot service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterSnapshotAlreadyExistsException"> User already has a DB cluster snapshot with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterSnapshotNotFoundException"> <i>DBClusterSnapshotIdentifier</i> does not refer to an existing DB cluster snapshot. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterStateException"> The supplied value is not a valid DB cluster state. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CopyDBClusterSnapshotAsync(Amazon.RDS.Model.CopyDBClusterSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopyDBClusterSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyDBClusterSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CopyDBParameterGroup(Amazon.RDS.Model.CopyDBParameterGroupRequest)"> <summary> Copies the specified DB parameter group. </summary> <param name="request">Container for the necessary parameters to execute the CopyDBParameterGroup service method.</param> <returns>The response from the CopyDBParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupAlreadyExistsException"> A DB parameter group with the same name exists. </exception> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.DBParameterGroupQuotaExceededException"> Request would result in user exceeding the allowed number of DB parameter groups. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CopyDBParameterGroupAsync(Amazon.RDS.Model.CopyDBParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopyDBParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyDBParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CopyDBSnapshot(Amazon.RDS.Model.CopyDBSnapshotRequest)"> <summary> Copies the specified DBSnapshot. The source DB snapshot must be in the "available" state. <para> If you are copying from a shared manual DB snapshot, the <code>SourceDBSnapshotIdentifier</code> must be the ARN of the shared DB snapshot. </para> </summary> <param name="request">Container for the necessary parameters to execute the CopyDBSnapshot service method.</param> <returns>The response from the CopyDBSnapshot service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSnapshotAlreadyExistsException"> <i>DBSnapshotIdentifier</i> is already used by an existing snapshot. </exception> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSnapshotStateException"> The state of the DB snapshot does not allow deletion. </exception> <exception cref="T:Amazon.RDS.Model.SnapshotQuotaExceededException"> Request would result in user exceeding the allowed number of DB snapshots. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CopyDBSnapshotAsync(Amazon.RDS.Model.CopyDBSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopyDBSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyDBSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CopyOptionGroup(Amazon.RDS.Model.CopyOptionGroupRequest)"> <summary> Copies the specified option group. </summary> <param name="request">Container for the necessary parameters to execute the CopyOptionGroup service method.</param> <returns>The response from the CopyOptionGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.OptionGroupAlreadyExistsException"> The option group you are trying to create already exists. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupQuotaExceededException"> The quota of 20 option groups was exceeded for this AWS account. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CopyOptionGroupAsync(Amazon.RDS.Model.CopyOptionGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopyOptionGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyOptionGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBCluster(Amazon.RDS.Model.CreateDBClusterRequest)"> <summary> Creates a new Amazon Aurora DB cluster. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </summary> <param name="request">Container for the necessary parameters to execute the CreateDBCluster service method.</param> <returns>The response from the CreateDBCluster service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterAlreadyExistsException"> User already has a DB cluster with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterParameterGroupNotFoundException"> <i>DBClusterParameterGroupName</i> does not refer to an existing DB Cluster parameter group. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterQuotaExceededException"> User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientStorageClusterCapacityException"> There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterStateException"> The supplied value is not a valid DB cluster state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSubnetGroupStateException"> The DB subnet group cannot be deleted because it is in use. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.KMSKeyNotAccessibleException"> Error accessing KMS key. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBClusterAsync(Amazon.RDS.Model.CreateDBClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBClusterParameterGroup(Amazon.RDS.Model.CreateDBClusterParameterGroupRequest)"> <summary> Creates a new DB cluster parameter group. <para> Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. </para> <para> A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using <a>ModifyDBClusterParameterGroup</a>. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using <a>ModifyDBCluster</a>. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. </para> <important> <para> After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <a>DescribeDBClusterParameters</a> command to verify that your DB cluster parameter group has been created or modified. </para> </important> <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDBClusterParameterGroup service method.</param> <returns>The response from the CreateDBClusterParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupAlreadyExistsException"> A DB parameter group with the same name exists. </exception> <exception cref="T:Amazon.RDS.Model.DBParameterGroupQuotaExceededException"> Request would result in user exceeding the allowed number of DB parameter groups. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBClusterParameterGroupAsync(Amazon.RDS.Model.CreateDBClusterParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBClusterParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBClusterParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBClusterSnapshot(Amazon.RDS.Model.CreateDBClusterSnapshotRequest)"> <summary> Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </summary> <param name="request">Container for the necessary parameters to execute the CreateDBClusterSnapshot service method.</param> <returns>The response from the CreateDBClusterSnapshot service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterNotFoundException"> <i>DBClusterIdentifier</i> does not refer to an existing DB cluster. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterSnapshotAlreadyExistsException"> User already has a DB cluster snapshot with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterStateException"> The supplied value is not a valid DB cluster state. </exception> <exception cref="T:Amazon.RDS.Model.SnapshotQuotaExceededException"> Request would result in user exceeding the allowed number of DB snapshots. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBClusterSnapshotAsync(Amazon.RDS.Model.CreateDBClusterSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBClusterSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBClusterSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBInstance(Amazon.RDS.Model.CreateDBInstanceRequest)"> <summary> Creates a new DB instance. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBInstance service method.</param> <returns>The response from the CreateDBInstance service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.AuthorizationNotFoundException"> Specified CIDRIP or EC2 security group is not authorized for the specified DB security group. <para> RDS may not also be authorized via IAM to perform necessary actions on your behalf. </para> </exception> <exception cref="T:Amazon.RDS.Model.DBClusterNotFoundException"> <i>DBClusterIdentifier</i> does not refer to an existing DB cluster. </exception> <exception cref="T:Amazon.RDS.Model.DBInstanceAlreadyExistsException"> User already has a DB instance with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupDoesNotCoverEnoughAZsException"> Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InstanceQuotaExceededException"> Request would result in user exceeding the allowed number of DB instances. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientDBInstanceCapacityException"> Specified DB instance class is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterStateException"> The supplied value is not a valid DB cluster state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.KMSKeyNotAccessibleException"> Error accessing KMS key. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> <exception cref="T:Amazon.RDS.Model.ProvisionedIopsNotAvailableInAZException"> Provisioned IOPS not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> <exception cref="T:Amazon.RDS.Model.StorageTypeNotSupportedException"> <i>StorageType</i> specified cannot be associated with the DB Instance. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBInstanceAsync(Amazon.RDS.Model.CreateDBInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBInstanceReadReplica(Amazon.RDS.Model.CreateDBInstanceReadReplicaRequest)"> <summary> Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance. <para> All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below. </para> <important> <para> The source DB instance must have backup retention enabled. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the CreateDBInstanceReadReplica service method.</param> <returns>The response from the CreateDBInstanceReadReplica service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceAlreadyExistsException"> User already has a DB instance with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupDoesNotCoverEnoughAZsException"> Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotAllowedException"> Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InstanceQuotaExceededException"> Request would result in user exceeding the allowed number of DB instances. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientDBInstanceCapacityException"> Specified DB instance class is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBInstanceStateException"> The specified DB instance is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSubnetGroupException"> Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.KMSKeyNotAccessibleException"> Error accessing KMS key. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> <exception cref="T:Amazon.RDS.Model.ProvisionedIopsNotAvailableInAZException"> Provisioned IOPS not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> <exception cref="T:Amazon.RDS.Model.StorageTypeNotSupportedException"> <i>StorageType</i> specified cannot be associated with the DB Instance. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBInstanceReadReplicaAsync(Amazon.RDS.Model.CreateDBInstanceReadReplicaRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBInstanceReadReplica operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBInstanceReadReplica operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBParameterGroup(Amazon.RDS.Model.CreateDBParameterGroupRequest)"> <summary> Creates a new DB parameter group. <para> A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using <i>ModifyDBParameterGroup</i>. Once you've created a DB parameter group, you need to associate it with your DB instance using <i>ModifyDBInstance</i>. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. </para> <important> <para> After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the CreateDBParameterGroup service method.</param> <returns>The response from the CreateDBParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupAlreadyExistsException"> A DB parameter group with the same name exists. </exception> <exception cref="T:Amazon.RDS.Model.DBParameterGroupQuotaExceededException"> Request would result in user exceeding the allowed number of DB parameter groups. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBParameterGroupAsync(Amazon.RDS.Model.CreateDBParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBSecurityGroup(Amazon.RDS.Model.CreateDBSecurityGroupRequest)"> <summary> Creates a new DB security group. DB security groups control access to a DB instance. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBSecurityGroup service method.</param> <returns>The response from the CreateDBSecurityGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupAlreadyExistsException"> A DB security group with the name specified in <i>DBSecurityGroupName</i> already exists. </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotSupportedException"> A DB security group is not allowed for this action. </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupQuotaExceededException"> Request would result in user exceeding the allowed number of DB security groups. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBSecurityGroupAsync(Amazon.RDS.Model.CreateDBSecurityGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBSecurityGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBSnapshot(Amazon.RDS.Model.CreateDBSnapshotRequest)"> <summary> Creates a DBSnapshot. The source DBInstance must be in "available" state. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBSnapshot service method.</param> <returns>The response from the CreateDBSnapshot service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBSnapshotAlreadyExistsException"> <i>DBSnapshotIdentifier</i> is already used by an existing snapshot. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBInstanceStateException"> The specified DB instance is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.RDS.Model.SnapshotQuotaExceededException"> Request would result in user exceeding the allowed number of DB snapshots. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBSnapshotAsync(Amazon.RDS.Model.CreateDBSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBSubnetGroup(Amazon.RDS.Model.CreateDBSubnetGroupRequest)"> <summary> Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBSubnetGroup service method.</param> <returns>The response from the CreateDBSubnetGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupAlreadyExistsException"> <i>DBSubnetGroupName</i> is already used by an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupDoesNotCoverEnoughAZsException"> Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupQuotaExceededException"> Request would result in user exceeding the allowed number of DB subnet groups. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetQuotaExceededException"> Request would result in user exceeding the allowed number of subnets in a DB subnet groups. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateDBSubnetGroupAsync(Amazon.RDS.Model.CreateDBSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDBSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDBSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateEventSubscription(Amazon.RDS.Model.CreateEventSubscriptionRequest)"> <summary> Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. <para> You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. </para> <para> If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateEventSubscription service method.</param> <returns>The response from the CreateEventSubscription service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.EventSubscriptionQuotaExceededException"> You have reached the maximum number of event subscriptions. </exception> <exception cref="T:Amazon.RDS.Model.SNSInvalidTopicException"> SNS has responded that there is a problem with the SND topic specified. </exception> <exception cref="T:Amazon.RDS.Model.SNSNoAuthorizationException"> You do not have permission to publish to the SNS topic ARN. </exception> <exception cref="T:Amazon.RDS.Model.SNSTopicArnNotFoundException"> The SNS topic ARN does not exist. </exception> <exception cref="T:Amazon.RDS.Model.SourceNotFoundException"> The requested source could not be found. </exception> <exception cref="T:Amazon.RDS.Model.SubscriptionAlreadyExistException"> The supplied subscription name already exists. </exception> <exception cref="T:Amazon.RDS.Model.SubscriptionCategoryNotFoundException"> The supplied category does not exist. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateEventSubscriptionAsync(Amazon.RDS.Model.CreateEventSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateEventSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateEventSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateOptionGroup(Amazon.RDS.Model.CreateOptionGroupRequest)"> <summary> Creates a new option group. You can create up to 20 option groups. </summary> <param name="request">Container for the necessary parameters to execute the CreateOptionGroup service method.</param> <returns>The response from the CreateOptionGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.OptionGroupAlreadyExistsException"> The option group you are trying to create already exists. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupQuotaExceededException"> The quota of 20 option groups was exceeded for this AWS account. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.CreateOptionGroupAsync(Amazon.RDS.Model.CreateOptionGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateOptionGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateOptionGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteDBCluster(Amazon.RDS.Model.DeleteDBClusterRequest)"> <summary> The DeleteDBCluster action deletes a previously provisioned DB cluster. A successful response from the web service indicates the request was received correctly. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the DB cluster to be deleted are not deleted. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBCluster service method.</param> <returns>The response from the DeleteDBCluster service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterNotFoundException"> <i>DBClusterIdentifier</i> does not refer to an existing DB cluster. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterStateException"> The supplied value is not a valid DB cluster state. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteDBClusterAsync(Amazon.RDS.Model.DeleteDBClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDBCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteDBClusterParameterGroup(Amazon.RDS.Model.DeleteDBClusterParameterGroupRequest)"> <summary> Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBClusterParameterGroup service method.</param> <returns>The response from the DeleteDBClusterParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBParameterGroupStateException"> The DB parameter group cannot be deleted because it is in use. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteDBClusterParameterGroupAsync(Amazon.RDS.Model.DeleteDBClusterParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDBClusterParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBClusterParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteDBClusterSnapshot(Amazon.RDS.Model.DeleteDBClusterSnapshotRequest)"> <summary> Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. <note>The DB cluster snapshot must be in the <code>available</code> state to be deleted.</note> <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBClusterSnapshot service method.</param> <returns>The response from the DeleteDBClusterSnapshot service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterSnapshotNotFoundException"> <i>DBClusterSnapshotIdentifier</i> does not refer to an existing DB cluster snapshot. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterSnapshotStateException"> The supplied value is not a valid DB cluster snapshot state. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteDBClusterSnapshotAsync(Amazon.RDS.Model.DeleteDBClusterSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDBClusterSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBClusterSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteDBInstance(Amazon.RDS.Model.DeleteDBInstanceRequest)"> <summary> The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted. <para> If a final DB snapshot is requested the status of the RDS instance will be "deleting" until the DB snapshot is created. The API action <code>DescribeDBInstance</code> is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted. </para> <para> Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true". </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBInstance service method.</param> <returns>The response from the DeleteDBInstance service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBSnapshotAlreadyExistsException"> <i>DBSnapshotIdentifier</i> is already used by an existing snapshot. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBInstanceStateException"> The specified DB instance is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.RDS.Model.SnapshotQuotaExceededException"> Request would result in user exceeding the allowed number of DB snapshots. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteDBInstanceAsync(Amazon.RDS.Model.DeleteDBInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDBInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteDBParameterGroup(Amazon.RDS.Model.DeleteDBParameterGroupRequest)"> <summary> Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBParameterGroup service method.</param> <returns>The response from the DeleteDBParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBParameterGroupStateException"> The DB parameter group cannot be deleted because it is in use. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteDBParameterGroupAsync(Amazon.RDS.Model.DeleteDBParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDBParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteDBSecurityGroup(Amazon.RDS.Model.DeleteDBSecurityGroupRequest)"> <summary> Deletes a DB security group. <note>The specified DB security group must not be associated with any DB instances.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBSecurityGroup service method.</param> <returns>The response from the DeleteDBSecurityGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSecurityGroupStateException"> The state of the DB security group does not allow deletion. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteDBSecurityGroupAsync(Amazon.RDS.Model.DeleteDBSecurityGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDBSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBSecurityGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteDBSnapshot(Amazon.RDS.Model.DeleteDBSnapshotRequest)"> <summary> Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated. <note>The DBSnapshot must be in the <code>available</code> state to be deleted.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBSnapshot service method.</param> <returns>The response from the DeleteDBSnapshot service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSnapshotStateException"> The state of the DB snapshot does not allow deletion. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteDBSnapshotAsync(Amazon.RDS.Model.DeleteDBSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDBSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteDBSubnetGroup(Amazon.RDS.Model.DeleteDBSubnetGroupRequest)"> <summary> Deletes a DB subnet group. <note>The specified database subnet group must not be associated with any DB instances.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBSubnetGroup service method.</param> <returns>The response from the DeleteDBSubnetGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSubnetGroupStateException"> The DB subnet group cannot be deleted because it is in use. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSubnetStateException"> The DB subnet is not in the <i>available</i> state. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteDBSubnetGroupAsync(Amazon.RDS.Model.DeleteDBSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDBSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDBSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteEventSubscription(Amazon.RDS.Model.DeleteEventSubscriptionRequest)"> <summary> Deletes an RDS event notification subscription. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEventSubscription service method.</param> <returns>The response from the DeleteEventSubscription service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.InvalidEventSubscriptionStateException"> This error can occur if someone else is modifying a subscription. You should retry the action. </exception> <exception cref="T:Amazon.RDS.Model.SubscriptionNotFoundException"> The subscription name does not exist. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteEventSubscriptionAsync(Amazon.RDS.Model.DeleteEventSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteEventSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEventSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteOptionGroup(Amazon.RDS.Model.DeleteOptionGroupRequest)"> <summary> Deletes an existing option group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteOptionGroup service method.</param> <returns>The response from the DeleteOptionGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.InvalidOptionGroupStateException"> The option group is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DeleteOptionGroupAsync(Amazon.RDS.Model.DeleteOptionGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteOptionGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteOptionGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeAccountAttributes"> <summary> Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. <para> This command does not take any parameters. </para> </summary> <returns>The response from the DescribeAccountAttributes service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeAccountAttributes(Amazon.RDS.Model.DescribeAccountAttributesRequest)"> <summary> Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. <para> This command does not take any parameters. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountAttributes service method.</param> <returns>The response from the DescribeAccountAttributes service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeAccountAttributesAsync(Amazon.RDS.Model.DescribeAccountAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAccountAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeCertificates(Amazon.RDS.Model.DescribeCertificatesRequest)"> <summary> Lists the set of CA certificates provided by Amazon RDS for this AWS account. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCertificates service method.</param> <returns>The response from the DescribeCertificates service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.CertificateNotFoundException"> <i>CertificateIdentifier</i> does not refer to an existing certificate. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeCertificatesAsync(Amazon.RDS.Model.DescribeCertificatesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCertificates operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCertificates operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBClusterParameterGroups(Amazon.RDS.Model.DescribeDBClusterParameterGroupsRequest)"> <summary> Returns a list of <code>DBClusterParameterGroup</code> descriptions. If a <code>DBClusterParameterGroupName</code> parameter is specified, the list will contain only the description of the specified DB cluster parameter group. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBClusterParameterGroups service method.</param> <returns>The response from the DescribeDBClusterParameterGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBClusterParameterGroupsAsync(Amazon.RDS.Model.DescribeDBClusterParameterGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBClusterParameterGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBClusterParameterGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBClusterParameters(Amazon.RDS.Model.DescribeDBClusterParametersRequest)"> <summary> Returns the detailed parameter list for a particular DB cluster parameter group. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBClusterParameters service method.</param> <returns>The response from the DescribeDBClusterParameters service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBClusterParametersAsync(Amazon.RDS.Model.DescribeDBClusterParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBClusterParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBClusterParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBClusters(Amazon.RDS.Model.DescribeDBClustersRequest)"> <summary> Returns information about provisioned Aurora DB clusters. This API supports pagination. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBClusters service method.</param> <returns>The response from the DescribeDBClusters service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterNotFoundException"> <i>DBClusterIdentifier</i> does not refer to an existing DB cluster. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBClustersAsync(Amazon.RDS.Model.DescribeDBClustersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBClusters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBClusterSnapshots(Amazon.RDS.Model.DescribeDBClusterSnapshotsRequest)"> <summary> Returns information about DB cluster snapshots. This API supports pagination. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBClusterSnapshots service method.</param> <returns>The response from the DescribeDBClusterSnapshots service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterSnapshotNotFoundException"> <i>DBClusterSnapshotIdentifier</i> does not refer to an existing DB cluster snapshot. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBClusterSnapshotsAsync(Amazon.RDS.Model.DescribeDBClusterSnapshotsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBClusterSnapshots operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBClusterSnapshots operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBEngineVersions"> <summary> Returns a list of the available DB engines. </summary> <returns>The response from the DescribeDBEngineVersions service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBEngineVersions(Amazon.RDS.Model.DescribeDBEngineVersionsRequest)"> <summary> Returns a list of the available DB engines. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBEngineVersions service method.</param> <returns>The response from the DescribeDBEngineVersions service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBEngineVersionsAsync(Amazon.RDS.Model.DescribeDBEngineVersionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBEngineVersions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBEngineVersions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBInstances"> <summary> Returns information about provisioned RDS instances. This API supports pagination. </summary> <returns>The response from the DescribeDBInstances service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBInstances(Amazon.RDS.Model.DescribeDBInstancesRequest)"> <summary> Returns information about provisioned RDS instances. This API supports pagination. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBInstances service method.</param> <returns>The response from the DescribeDBInstances service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBInstancesAsync(Amazon.RDS.Model.DescribeDBInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBLogFiles(Amazon.RDS.Model.DescribeDBLogFilesRequest)"> <summary> Returns a list of DB log files for the DB instance. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBLogFiles service method.</param> <returns>The response from the DescribeDBLogFiles service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBLogFilesAsync(Amazon.RDS.Model.DescribeDBLogFilesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBLogFiles operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBLogFiles operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBParameterGroups"> <summary> Returns a list of <code>DBParameterGroup</code> descriptions. If a <code>DBParameterGroupName</code> is specified, the list will contain only the description of the specified DB parameter group. </summary> <returns>The response from the DescribeDBParameterGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBParameterGroups(Amazon.RDS.Model.DescribeDBParameterGroupsRequest)"> <summary> Returns a list of <code>DBParameterGroup</code> descriptions. If a <code>DBParameterGroupName</code> is specified, the list will contain only the description of the specified DB parameter group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBParameterGroups service method.</param> <returns>The response from the DescribeDBParameterGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBParameterGroupsAsync(Amazon.RDS.Model.DescribeDBParameterGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBParameterGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBParameterGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBParameters(Amazon.RDS.Model.DescribeDBParametersRequest)"> <summary> Returns the detailed parameter list for a particular DB parameter group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBParameters service method.</param> <returns>The response from the DescribeDBParameters service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBParametersAsync(Amazon.RDS.Model.DescribeDBParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBSecurityGroups"> <summary> Returns a list of <code>DBSecurityGroup</code> descriptions. If a <code>DBSecurityGroupName</code> is specified, the list will contain only the descriptions of the specified DB security group. </summary> <returns>The response from the DescribeDBSecurityGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBSecurityGroups(Amazon.RDS.Model.DescribeDBSecurityGroupsRequest)"> <summary> Returns a list of <code>DBSecurityGroup</code> descriptions. If a <code>DBSecurityGroupName</code> is specified, the list will contain only the descriptions of the specified DB security group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBSecurityGroups service method.</param> <returns>The response from the DescribeDBSecurityGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBSecurityGroupsAsync(Amazon.RDS.Model.DescribeDBSecurityGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBSecurityGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBSecurityGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBSnapshotAttributes(Amazon.RDS.Model.DescribeDBSnapshotAttributesRequest)"> <summary> Returns a list of DB snapshot attribute names and values for a manual DB snapshot. <para> When sharing snapshots with other AWS accounts, <code>DescribeDBSnapshotAttributes</code> returns the <code>restore</code> attribute and a list of the AWS account ids that are authorized to copy or restore the manual DB snapshot. If <code>all</code> is included in the list of values for the <code>restore</code> attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts. </para> <para> To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the <a>ModifyDBSnapshotAttribute</a> API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBSnapshotAttributes service method.</param> <returns>The response from the DescribeDBSnapshotAttributes service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBSnapshotAttributesAsync(Amazon.RDS.Model.DescribeDBSnapshotAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBSnapshotAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBSnapshotAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBSnapshots"> <summary> Returns information about DB snapshots. This API supports pagination. </summary> <returns>The response from the DescribeDBSnapshots service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBSnapshots(Amazon.RDS.Model.DescribeDBSnapshotsRequest)"> <summary> Returns information about DB snapshots. This API supports pagination. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBSnapshots service method.</param> <returns>The response from the DescribeDBSnapshots service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBSnapshotsAsync(Amazon.RDS.Model.DescribeDBSnapshotsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBSnapshots operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBSnapshots operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBSubnetGroups"> <summary> Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. <para> For an overview of CIDR ranges, go to the <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Wikipedia Tutorial</a>. </para> </summary> <returns>The response from the DescribeDBSubnetGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBSubnetGroups(Amazon.RDS.Model.DescribeDBSubnetGroupsRequest)"> <summary> Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. <para> For an overview of CIDR ranges, go to the <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Wikipedia Tutorial</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBSubnetGroups service method.</param> <returns>The response from the DescribeDBSubnetGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeDBSubnetGroupsAsync(Amazon.RDS.Model.DescribeDBSubnetGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDBSubnetGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDBSubnetGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeEngineDefaultClusterParameters(Amazon.RDS.Model.DescribeEngineDefaultClusterParametersRequest)"> <summary> Returns the default engine and system parameter information for the cluster database engine. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEngineDefaultClusterParameters service method.</param> <returns>The response from the DescribeEngineDefaultClusterParameters service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeEngineDefaultClusterParametersAsync(Amazon.RDS.Model.DescribeEngineDefaultClusterParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEngineDefaultClusterParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEngineDefaultClusterParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeEngineDefaultParameters(Amazon.RDS.Model.DescribeEngineDefaultParametersRequest)"> <summary> Returns the default engine and system parameter information for the specified database engine. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEngineDefaultParameters service method.</param> <returns>The response from the DescribeEngineDefaultParameters service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeEngineDefaultParametersAsync(Amazon.RDS.Model.DescribeEngineDefaultParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEngineDefaultParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEngineDefaultParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeEventCategories"> <summary> Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html"> Events</a> topic in the <i>Amazon RDS User Guide.</i> </summary> <returns>The response from the DescribeEventCategories service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeEventCategories(Amazon.RDS.Model.DescribeEventCategoriesRequest)"> <summary> Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html"> Events</a> topic in the <i>Amazon RDS User Guide.</i> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventCategories service method.</param> <returns>The response from the DescribeEventCategories service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeEventCategoriesAsync(Amazon.RDS.Model.DescribeEventCategoriesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEventCategories operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventCategories operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeEvents"> <summary> Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. </summary> <returns>The response from the DescribeEvents service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeEvents(Amazon.RDS.Model.DescribeEventsRequest)"> <summary> Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents service method.</param> <returns>The response from the DescribeEvents service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeEventsAsync(Amazon.RDS.Model.DescribeEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeEventSubscriptions"> <summary> Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. <para> If you specify a SubscriptionName, lists the description for that subscription. </para> </summary> <returns>The response from the DescribeEventSubscriptions service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.SubscriptionNotFoundException"> The subscription name does not exist. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeEventSubscriptions(Amazon.RDS.Model.DescribeEventSubscriptionsRequest)"> <summary> Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. <para> If you specify a SubscriptionName, lists the description for that subscription. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventSubscriptions service method.</param> <returns>The response from the DescribeEventSubscriptions service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.SubscriptionNotFoundException"> The subscription name does not exist. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeEventSubscriptionsAsync(Amazon.RDS.Model.DescribeEventSubscriptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEventSubscriptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventSubscriptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeOptionGroupOptions(Amazon.RDS.Model.DescribeOptionGroupOptionsRequest)"> <summary> Describes all available options. </summary> <param name="request">Container for the necessary parameters to execute the DescribeOptionGroupOptions service method.</param> <returns>The response from the DescribeOptionGroupOptions service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeOptionGroupOptionsAsync(Amazon.RDS.Model.DescribeOptionGroupOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeOptionGroupOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeOptionGroupOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeOptionGroups"> <summary> Describes the available option groups. </summary> <returns>The response from the DescribeOptionGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeOptionGroups(Amazon.RDS.Model.DescribeOptionGroupsRequest)"> <summary> Describes the available option groups. </summary> <param name="request">Container for the necessary parameters to execute the DescribeOptionGroups service method.</param> <returns>The response from the DescribeOptionGroups service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeOptionGroupsAsync(Amazon.RDS.Model.DescribeOptionGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeOptionGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeOptionGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeOrderableDBInstanceOptions(Amazon.RDS.Model.DescribeOrderableDBInstanceOptionsRequest)"> <summary> Returns a list of orderable DB instance options for the specified engine. </summary> <param name="request">Container for the necessary parameters to execute the DescribeOrderableDBInstanceOptions service method.</param> <returns>The response from the DescribeOrderableDBInstanceOptions service method, as returned by RDS.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeOrderableDBInstanceOptionsAsync(Amazon.RDS.Model.DescribeOrderableDBInstanceOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeOrderableDBInstanceOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeOrderableDBInstanceOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribePendingMaintenanceActions(Amazon.RDS.Model.DescribePendingMaintenanceActionsRequest)"> <summary> Returns a list of resources (for example, DB instances) that have at least one pending maintenance action. </summary> <param name="request">Container for the necessary parameters to execute the DescribePendingMaintenanceActions service method.</param> <returns>The response from the DescribePendingMaintenanceActions service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.ResourceNotFoundException"> The specified resource ID was not found. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribePendingMaintenanceActionsAsync(Amazon.RDS.Model.DescribePendingMaintenanceActionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribePendingMaintenanceActions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePendingMaintenanceActions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeReservedDBInstances"> <summary> Returns information about reserved DB instances for this account, or about a specified reserved DB instance. </summary> <returns>The response from the DescribeReservedDBInstances service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.ReservedDBInstanceNotFoundException"> The specified reserved DB Instance not found. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeReservedDBInstances(Amazon.RDS.Model.DescribeReservedDBInstancesRequest)"> <summary> Returns information about reserved DB instances for this account, or about a specified reserved DB instance. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedDBInstances service method.</param> <returns>The response from the DescribeReservedDBInstances service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.ReservedDBInstanceNotFoundException"> The specified reserved DB Instance not found. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeReservedDBInstancesAsync(Amazon.RDS.Model.DescribeReservedDBInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedDBInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedDBInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeReservedDBInstancesOfferings"> <summary> Lists available reserved DB instance offerings. </summary> <returns>The response from the DescribeReservedDBInstancesOfferings service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.ReservedDBInstancesOfferingNotFoundException"> Specified offering does not exist. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeReservedDBInstancesOfferings(Amazon.RDS.Model.DescribeReservedDBInstancesOfferingsRequest)"> <summary> Lists available reserved DB instance offerings. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedDBInstancesOfferings service method.</param> <returns>The response from the DescribeReservedDBInstancesOfferings service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.ReservedDBInstancesOfferingNotFoundException"> Specified offering does not exist. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DescribeReservedDBInstancesOfferingsAsync(Amazon.RDS.Model.DescribeReservedDBInstancesOfferingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedDBInstancesOfferings operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedDBInstancesOfferings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DownloadDBLogFilePortion(Amazon.RDS.Model.DownloadDBLogFilePortionRequest)"> <summary> Downloads all or a portion of the specified log file, up to 1 MB in size. </summary> <param name="request">Container for the necessary parameters to execute the DownloadDBLogFilePortion service method.</param> <returns>The response from the DownloadDBLogFilePortion service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBLogFileNotFoundException"> <i>LogFileName</i> does not refer to an existing DB log file. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.DownloadDBLogFilePortionAsync(Amazon.RDS.Model.DownloadDBLogFilePortionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DownloadDBLogFilePortion operation. </summary> <param name="request">Container for the necessary parameters to execute the DownloadDBLogFilePortion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.FailoverDBCluster(Amazon.RDS.Model.FailoverDBClusterRequest)"> <summary> Forces a failover for a DB cluster. <para> A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance. </para> <para> Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. </para> <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the FailoverDBCluster service method.</param> <returns>The response from the FailoverDBCluster service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterNotFoundException"> <i>DBClusterIdentifier</i> does not refer to an existing DB cluster. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterStateException"> The supplied value is not a valid DB cluster state. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.FailoverDBClusterAsync(Amazon.RDS.Model.FailoverDBClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the FailoverDBCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the FailoverDBCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ListTagsForResource(Amazon.RDS.Model.ListTagsForResourceRequest)"> <summary> Lists all tags on an Amazon RDS resource. <para> For an overview on tagging an Amazon RDS resource, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html">Tagging Amazon RDS Resources</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResource service method.</param> <returns>The response from the ListTagsForResource service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ListTagsForResourceAsync(Amazon.RDS.Model.ListTagsForResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTagsForResource operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ModifyDBCluster(Amazon.RDS.Model.ModifyDBClusterRequest)"> <summary> Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBCluster service method.</param> <returns>The response from the ModifyDBCluster service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterAlreadyExistsException"> User already has a DB cluster with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterNotFoundException"> <i>DBClusterIdentifier</i> does not refer to an existing DB cluster. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterParameterGroupNotFoundException"> <i>DBClusterParameterGroupName</i> does not refer to an existing DB Cluster parameter group. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterStateException"> The supplied value is not a valid DB cluster state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBInstanceStateException"> The specified DB instance is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSecurityGroupStateException"> The state of the DB security group does not allow deletion. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSubnetGroupStateException"> The DB subnet group cannot be deleted because it is in use. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ModifyDBClusterAsync(Amazon.RDS.Model.ModifyDBClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyDBCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ModifyDBClusterParameterGroup(Amazon.RDS.Model.ModifyDBClusterParameterGroupRequest)"> <summary> Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> <note> <para> Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect. </para> </note> <important> <para> After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <a>DescribeDBClusterParameters</a> command to verify that your DB cluster parameter group has been created or modified. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBClusterParameterGroup service method.</param> <returns>The response from the ModifyDBClusterParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBParameterGroupStateException"> The DB parameter group cannot be deleted because it is in use. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ModifyDBClusterParameterGroupAsync(Amazon.RDS.Model.ModifyDBClusterParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyDBClusterParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBClusterParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ModifyDBInstance(Amazon.RDS.Model.ModifyDBInstanceRequest)"> <summary> Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBInstance service method.</param> <returns>The response from the ModifyDBInstance service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.AuthorizationNotFoundException"> Specified CIDRIP or EC2 security group is not authorized for the specified DB security group. <para> RDS may not also be authorized via IAM to perform necessary actions on your behalf. </para> </exception> <exception cref="T:Amazon.RDS.Model.CertificateNotFoundException"> <i>CertificateIdentifier</i> does not refer to an existing certificate. </exception> <exception cref="T:Amazon.RDS.Model.DBInstanceAlreadyExistsException"> User already has a DB instance with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> <exception cref="T:Amazon.RDS.Model.DBUpgradeDependencyFailureException"> The DB upgrade failed because a resource the DB depends on could not be modified. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientDBInstanceCapacityException"> Specified DB instance class is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBInstanceStateException"> The specified DB instance is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSecurityGroupStateException"> The state of the DB security group does not allow deletion. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> <exception cref="T:Amazon.RDS.Model.ProvisionedIopsNotAvailableInAZException"> Provisioned IOPS not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> <exception cref="T:Amazon.RDS.Model.StorageTypeNotSupportedException"> <i>StorageType</i> specified cannot be associated with the DB Instance. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ModifyDBInstanceAsync(Amazon.RDS.Model.ModifyDBInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyDBInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ModifyDBParameterGroup(Amazon.RDS.Model.ModifyDBParameterGroupRequest)"> <summary> Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. <note> <para> Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect. </para> </note> <important> <para> After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBParameterGroup service method.</param> <returns>The response from the ModifyDBParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBParameterGroupStateException"> The DB parameter group cannot be deleted because it is in use. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ModifyDBParameterGroupAsync(Amazon.RDS.Model.ModifyDBParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyDBParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ModifyDBSnapshotAttribute(Amazon.RDS.Model.ModifyDBSnapshotAttributeRequest)"> <summary> Adds an attribute and values to, or removes an attribute and values from a manual DB snapshot. <para> To share a manual DB snapshot with other AWS accounts, specify <code>restore</code> as the <code>AttributeName</code> and use the <code>ValuesToAdd</code> parameter to add a list of the AWS account ids that are authorized to retore the manual DB snapshot. Uses the value <code>all</code> to make the manual DB snapshot public and can by copied or restored by all AWS accounts. Do not add the <code>all</code> value for any manual DB snapshots that contain private information that you do not want to be available to all AWS accounts. </para> <para> To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the <a>DescribeDBSnapshotAttributes</a> API. </para> <para> If the manual DB snapshot is encrypted, it cannot be shared. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBSnapshotAttribute service method.</param> <returns>The response from the ModifyDBSnapshotAttribute service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSnapshotStateException"> The state of the DB snapshot does not allow deletion. </exception> <exception cref="T:Amazon.RDS.Model.SharedSnapshotQuotaExceededException"> You have exceeded the maximum number of account ids that you can share a manual DB snapshot with. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ModifyDBSnapshotAttributeAsync(Amazon.RDS.Model.ModifyDBSnapshotAttributeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyDBSnapshotAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBSnapshotAttribute operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ModifyDBSubnetGroup(Amazon.RDS.Model.ModifyDBSubnetGroupRequest)"> <summary> Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region. </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBSubnetGroup service method.</param> <returns>The response from the ModifyDBSubnetGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupDoesNotCoverEnoughAZsException"> Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetQuotaExceededException"> Request would result in user exceeding the allowed number of subnets in a DB subnet groups. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.SubnetAlreadyInUseException"> The DB subnet is already in use in the Availability Zone. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ModifyDBSubnetGroupAsync(Amazon.RDS.Model.ModifyDBSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyDBSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyDBSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ModifyEventSubscription(Amazon.RDS.Model.ModifyEventSubscriptionRequest)"> <summary> Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the <a>AddSourceIdentifierToSubscription</a> and <a>RemoveSourceIdentifierFromSubscription</a> calls. <para> You can see a list of the event categories for a given SourceType in the <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html">Events</a> topic in the Amazon RDS User Guide or by using the <b>DescribeEventCategories</b> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyEventSubscription service method.</param> <returns>The response from the ModifyEventSubscription service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.EventSubscriptionQuotaExceededException"> You have reached the maximum number of event subscriptions. </exception> <exception cref="T:Amazon.RDS.Model.SNSInvalidTopicException"> SNS has responded that there is a problem with the SND topic specified. </exception> <exception cref="T:Amazon.RDS.Model.SNSNoAuthorizationException"> You do not have permission to publish to the SNS topic ARN. </exception> <exception cref="T:Amazon.RDS.Model.SNSTopicArnNotFoundException"> The SNS topic ARN does not exist. </exception> <exception cref="T:Amazon.RDS.Model.SubscriptionCategoryNotFoundException"> The supplied category does not exist. </exception> <exception cref="T:Amazon.RDS.Model.SubscriptionNotFoundException"> The subscription name does not exist. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ModifyEventSubscriptionAsync(Amazon.RDS.Model.ModifyEventSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyEventSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyEventSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ModifyOptionGroup(Amazon.RDS.Model.ModifyOptionGroupRequest)"> <summary> Modifies an existing option group. </summary> <param name="request">Container for the necessary parameters to execute the ModifyOptionGroup service method.</param> <returns>The response from the ModifyOptionGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.InvalidOptionGroupStateException"> The option group is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ModifyOptionGroupAsync(Amazon.RDS.Model.ModifyOptionGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyOptionGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyOptionGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.PromoteReadReplica(Amazon.RDS.Model.PromoteReadReplicaRequest)"> <summary> Promotes a Read Replica DB instance to a standalone DB instance. <note> <para> We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the PromoteReadReplica service method.</param> <returns>The response from the PromoteReadReplica service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBInstanceStateException"> The specified DB instance is not in the <i>available</i> state. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.PromoteReadReplicaAsync(Amazon.RDS.Model.PromoteReadReplicaRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PromoteReadReplica operation. </summary> <param name="request">Container for the necessary parameters to execute the PromoteReadReplica operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.PurchaseReservedDBInstancesOffering(Amazon.RDS.Model.PurchaseReservedDBInstancesOfferingRequest)"> <summary> Purchases a reserved DB instance offering. </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedDBInstancesOffering service method.</param> <returns>The response from the PurchaseReservedDBInstancesOffering service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.ReservedDBInstanceAlreadyExistsException"> User already has a reservation with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.ReservedDBInstanceQuotaExceededException"> Request would exceed the user's DB Instance quota. </exception> <exception cref="T:Amazon.RDS.Model.ReservedDBInstancesOfferingNotFoundException"> Specified offering does not exist. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.PurchaseReservedDBInstancesOfferingAsync(Amazon.RDS.Model.PurchaseReservedDBInstancesOfferingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PurchaseReservedDBInstancesOffering operation. </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedDBInstancesOffering operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.RebootDBInstance(Amazon.RDS.Model.RebootDBInstanceRequest)"> <summary> Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed. <para> If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs. </para> <para> The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions. </para> </summary> <param name="request">Container for the necessary parameters to execute the RebootDBInstance service method.</param> <returns>The response from the RebootDBInstance service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBInstanceStateException"> The specified DB instance is not in the <i>available</i> state. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.RebootDBInstanceAsync(Amazon.RDS.Model.RebootDBInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RebootDBInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the RebootDBInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.RemoveSourceIdentifierFromSubscription(Amazon.RDS.Model.RemoveSourceIdentifierFromSubscriptionRequest)"> <summary> Removes a source identifier from an existing RDS event notification subscription. </summary> <param name="request">Container for the necessary parameters to execute the RemoveSourceIdentifierFromSubscription service method.</param> <returns>The response from the RemoveSourceIdentifierFromSubscription service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.SourceNotFoundException"> The requested source could not be found. </exception> <exception cref="T:Amazon.RDS.Model.SubscriptionNotFoundException"> The subscription name does not exist. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.RemoveSourceIdentifierFromSubscriptionAsync(Amazon.RDS.Model.RemoveSourceIdentifierFromSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveSourceIdentifierFromSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveSourceIdentifierFromSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.RemoveTagsFromResource(Amazon.RDS.Model.RemoveTagsFromResourceRequest)"> <summary> Removes metadata tags from an Amazon RDS resource. <para> For an overview on tagging an Amazon RDS resource, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html">Tagging Amazon RDS Resources</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromResource service method.</param> <returns>The response from the RemoveTagsFromResource service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.RemoveTagsFromResourceAsync(Amazon.RDS.Model.RemoveTagsFromResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTagsFromResource operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ResetDBClusterParameterGroup(Amazon.RDS.Model.ResetDBClusterParameterGroupRequest)"> <summary> Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire DB cluster parameter group, specify the <code>DBClusterParameterGroupName</code> and <code>ResetAllParameters</code> parameters. <para> When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance restart or <a>RebootDBInstance</a> request. You must call <a>RebootDBInstance</a> for every DB instance in your DB cluster that you want the updated static parameter to apply to. </para> <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the ResetDBClusterParameterGroup service method.</param> <returns>The response from the ResetDBClusterParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBParameterGroupStateException"> The DB parameter group cannot be deleted because it is in use. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ResetDBClusterParameterGroupAsync(Amazon.RDS.Model.ResetDBClusterParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetDBClusterParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetDBClusterParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ResetDBParameterGroup(Amazon.RDS.Model.ResetDBParameterGroupRequest)"> <summary> Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire DB parameter group, specify the <code>DBParameterGroup</code> name and <code>ResetAllParameters</code> parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance restart or <code>RebootDBInstance</code> request. </summary> <param name="request">Container for the necessary parameters to execute the ResetDBParameterGroup service method.</param> <returns>The response from the ResetDBParameterGroup service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBParameterGroupNotFoundException"> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBParameterGroupStateException"> The DB parameter group cannot be deleted because it is in use. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.ResetDBParameterGroupAsync(Amazon.RDS.Model.ResetDBParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetDBParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetDBParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.RestoreDBClusterFromSnapshot(Amazon.RDS.Model.RestoreDBClusterFromSnapshotRequest)"> <summary> Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the RestoreDBClusterFromSnapshot service method.</param> <returns>The response from the RestoreDBClusterFromSnapshot service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterAlreadyExistsException"> User already has a DB cluster with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterQuotaExceededException"> User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterSnapshotNotFoundException"> <i>DBClusterSnapshotIdentifier</i> does not refer to an existing DB cluster snapshot. </exception> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientDBClusterCapacityException"> The DB cluster does not have enough capacity for the current operation. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientStorageClusterCapacityException"> There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterSnapshotStateException"> The supplied value is not a valid DB cluster snapshot state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSnapshotStateException"> The state of the DB snapshot does not allow deletion. </exception> <exception cref="T:Amazon.RDS.Model.InvalidRestoreException"> Cannot restore from vpc backup to non-vpc DB instance. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.KMSKeyNotAccessibleException"> Error accessing KMS key. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.RestoreDBClusterFromSnapshotAsync(Amazon.RDS.Model.RestoreDBClusterFromSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestoreDBClusterFromSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreDBClusterFromSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.RestoreDBClusterToPointInTime(Amazon.RDS.Model.RestoreDBClusterToPointInTimeRequest)"> <summary> Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before <code>LatestRestorableTime</code> for up to <code>BackupRetentionPeriod</code> days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </para> </summary> <param name="request">Container for the necessary parameters to execute the RestoreDBClusterToPointInTime service method.</param> <returns>The response from the RestoreDBClusterToPointInTime service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.DBClusterAlreadyExistsException"> User already has a DB cluster with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterNotFoundException"> <i>DBClusterIdentifier</i> does not refer to an existing DB cluster. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterQuotaExceededException"> User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota. </exception> <exception cref="T:Amazon.RDS.Model.DBClusterSnapshotNotFoundException"> <i>DBClusterSnapshotIdentifier</i> does not refer to an existing DB cluster snapshot. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientDBClusterCapacityException"> The DB cluster does not have enough capacity for the current operation. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBClusterSnapshotStateException"> The supplied value is not a valid DB cluster snapshot state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSnapshotStateException"> The state of the DB snapshot does not allow deletion. </exception> <exception cref="T:Amazon.RDS.Model.InvalidRestoreException"> Cannot restore from vpc backup to non-vpc DB instance. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.KMSKeyNotAccessibleException"> Error accessing KMS key. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.RestoreDBClusterToPointInTimeAsync(Amazon.RDS.Model.RestoreDBClusterToPointInTimeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestoreDBClusterToPointInTime operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreDBClusterToPointInTime operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.RestoreDBInstanceFromDBSnapshot(Amazon.RDS.Model.RestoreDBInstanceFromDBSnapshotRequest)"> <summary> Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment. <para> If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot. </para> <para> If you are restoring from a shared manual DB snapshot, the <code>DBSnapshotIdentifier</code> must be the ARN of the shared DB snapshot. </para> </summary> <param name="request">Container for the necessary parameters to execute the RestoreDBInstanceFromDBSnapshot service method.</param> <returns>The response from the RestoreDBInstanceFromDBSnapshot service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.AuthorizationNotFoundException"> Specified CIDRIP or EC2 security group is not authorized for the specified DB security group. <para> RDS may not also be authorized via IAM to perform necessary actions on your behalf. </para> </exception> <exception cref="T:Amazon.RDS.Model.DBInstanceAlreadyExistsException"> User already has a DB instance with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> <exception cref="T:Amazon.RDS.Model.DBSnapshotNotFoundException"> <i>DBSnapshotIdentifier</i> does not refer to an existing DB snapshot. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupDoesNotCoverEnoughAZsException"> Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InstanceQuotaExceededException"> Request would result in user exceeding the allowed number of DB instances. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientDBInstanceCapacityException"> Specified DB instance class is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSnapshotStateException"> The state of the DB snapshot does not allow deletion. </exception> <exception cref="T:Amazon.RDS.Model.InvalidRestoreException"> Cannot restore from vpc backup to non-vpc DB instance. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.KMSKeyNotAccessibleException"> Error accessing KMS key. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> <exception cref="T:Amazon.RDS.Model.ProvisionedIopsNotAvailableInAZException"> Provisioned IOPS not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> <exception cref="T:Amazon.RDS.Model.StorageTypeNotSupportedException"> <i>StorageType</i> specified cannot be associated with the DB Instance. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.RestoreDBInstanceFromDBSnapshotAsync(Amazon.RDS.Model.RestoreDBInstanceFromDBSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestoreDBInstanceFromDBSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreDBInstanceFromDBSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.RestoreDBInstanceToPointInTime(Amazon.RDS.Model.RestoreDBInstanceToPointInTimeRequest)"> <summary> Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property. <para> The target database is created with most of the original configuration, but in a system-selected availability zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment. </para> </summary> <param name="request">Container for the necessary parameters to execute the RestoreDBInstanceToPointInTime service method.</param> <returns>The response from the RestoreDBInstanceToPointInTime service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.AuthorizationNotFoundException"> Specified CIDRIP or EC2 security group is not authorized for the specified DB security group. <para> RDS may not also be authorized via IAM to perform necessary actions on your behalf. </para> </exception> <exception cref="T:Amazon.RDS.Model.DBInstanceAlreadyExistsException"> User already has a DB instance with the given identifier. </exception> <exception cref="T:Amazon.RDS.Model.DBInstanceNotFoundException"> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance. </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupDoesNotCoverEnoughAZsException"> Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.DBSubnetGroupNotFoundException"> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </exception> <exception cref="T:Amazon.RDS.Model.InstanceQuotaExceededException"> Request would result in user exceeding the allowed number of DB instances. </exception> <exception cref="T:Amazon.RDS.Model.InsufficientDBInstanceCapacityException"> Specified DB instance class is not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBInstanceStateException"> The specified DB instance is not in the <i>available</i> state. </exception> <exception cref="T:Amazon.RDS.Model.InvalidRestoreException"> Cannot restore from vpc backup to non-vpc DB instance. </exception> <exception cref="T:Amazon.RDS.Model.InvalidSubnetException"> The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. </exception> <exception cref="T:Amazon.RDS.Model.InvalidVPCNetworkStateException"> DB subnet group does not cover all Availability Zones after it is created because users' change. </exception> <exception cref="T:Amazon.RDS.Model.KMSKeyNotAccessibleException"> Error accessing KMS key. </exception> <exception cref="T:Amazon.RDS.Model.OptionGroupNotFoundException"> The specified option group could not be found. </exception> <exception cref="T:Amazon.RDS.Model.PointInTimeRestoreNotEnabledException"> <i>SourceDBInstanceIdentifier</i> refers to a DB instance with <i>BackupRetentionPeriod</i> equal to 0. </exception> <exception cref="T:Amazon.RDS.Model.ProvisionedIopsNotAvailableInAZException"> Provisioned IOPS not available in the specified Availability Zone. </exception> <exception cref="T:Amazon.RDS.Model.StorageQuotaExceededException"> Request would result in user exceeding the allowed amount of storage available across all DB instances. </exception> <exception cref="T:Amazon.RDS.Model.StorageTypeNotSupportedException"> <i>StorageType</i> specified cannot be associated with the DB Instance. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.RestoreDBInstanceToPointInTimeAsync(Amazon.RDS.Model.RestoreDBInstanceToPointInTimeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestoreDBInstanceToPointInTime operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreDBInstanceToPointInTime operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.RDS.AmazonRDSClient.RevokeDBSecurityGroupIngress(Amazon.RDS.Model.RevokeDBSecurityGroupIngressRequest)"> <summary> Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId). </summary> <param name="request">Container for the necessary parameters to execute the RevokeDBSecurityGroupIngress service method.</param> <returns>The response from the RevokeDBSecurityGroupIngress service method, as returned by RDS.</returns> <exception cref="T:Amazon.RDS.Model.AuthorizationNotFoundException"> Specified CIDRIP or EC2 security group is not authorized for the specified DB security group. <para> RDS may not also be authorized via IAM to perform necessary actions on your behalf. </para> </exception> <exception cref="T:Amazon.RDS.Model.DBSecurityGroupNotFoundException"> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </exception> <exception cref="T:Amazon.RDS.Model.InvalidDBSecurityGroupStateException"> The state of the DB security group does not allow deletion. </exception> </member> <member name="M:Amazon.RDS.AmazonRDSClient.RevokeDBSecurityGroupIngressAsync(Amazon.RDS.Model.RevokeDBSecurityGroupIngressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RevokeDBSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeDBSecurityGroupIngress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.Redshift.AmazonRedshiftClient"> <summary> Implementation for accessing Redshift Amazon Redshift <b>Overview</b> <para> This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/using-aws-sdk.html">Using the Amazon Redshift Management Interfaces </a>. </para> <para> Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers. </para> <para> If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the The <a href="http://docs.aws.amazon.com/redshift/latest/gsg/getting-started.html">Amazon Redshift Getting Started Guide</a> </para> <para> If you are a database developer, the <a href="http://docs.aws.amazon.com/redshift/latest/dg/welcome.html">Amazon Redshift Database Developer Guide</a> explains how to design, build, query, and maintain the databases that make up your data warehouse. </para> </summary> </member> <member name="T:Amazon.Redshift.IAmazonRedshift"> <summary> Interface for accessing Redshift Amazon Redshift <b>Overview</b> <para> This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/using-aws-sdk.html">Using the Amazon Redshift Management Interfaces </a>. </para> <para> Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers. </para> <para> If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the The <a href="http://docs.aws.amazon.com/redshift/latest/gsg/getting-started.html">Amazon Redshift Getting Started Guide</a> </para> <para> If you are a database developer, the <a href="http://docs.aws.amazon.com/redshift/latest/dg/welcome.html">Amazon Redshift Database Developer Guide</a> explains how to design, build, query, and maintain the databases that make up your data warehouse. </para> </summary> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.AuthorizeClusterSecurityGroupIngress(Amazon.Redshift.Model.AuthorizeClusterSecurityGroupIngressRequest)"> <summary> Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR) IP address range or an EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group. <note> The EC2 security group must be defined in the AWS region where the cluster resides. </note> <para> For an overview of CIDR blocks, see the Wikipedia article on <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>. </para> <para> You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Working with Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeClusterSecurityGroupIngress service method.</param> <returns>The response from the AuthorizeClusterSecurityGroupIngress service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.AuthorizationAlreadyExistsException"> The specified CIDR block or EC2 security group is already authorized for the specified cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.AuthorizationQuotaExceededException"> The authorization quota for the cluster security group has been reached. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupNotFoundException"> The cluster security group name does not refer to an existing cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSecurityGroupStateException"> The state of the cluster security group is not <code>available</code>. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.AuthorizeClusterSecurityGroupIngressAsync(Amazon.Redshift.Model.AuthorizeClusterSecurityGroupIngressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AuthorizeClusterSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeClusterSecurityGroupIngress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.AuthorizeSnapshotAccess(Amazon.Redshift.Model.AuthorizeSnapshotAccessRequest)"> <summary> Authorizes the specified AWS customer account to restore the specified snapshot. <para> For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSnapshotAccess service method.</param> <returns>The response from the AuthorizeSnapshotAccess service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.AuthorizationAlreadyExistsException"> The specified CIDR block or EC2 security group is already authorized for the specified cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.AuthorizationQuotaExceededException"> The authorization quota for the cluster security group has been reached. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotNotFoundException"> The snapshot identifier does not refer to an existing cluster snapshot. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.AuthorizeSnapshotAccessAsync(Amazon.Redshift.Model.AuthorizeSnapshotAccessRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AuthorizeSnapshotAccess operation. </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSnapshotAccess operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CopyClusterSnapshot(Amazon.Redshift.Model.CopyClusterSnapshotRequest)"> <summary> Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state. <para> When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them. </para> <para> For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CopyClusterSnapshot service method.</param> <returns>The response from the CopyClusterSnapshot service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotAlreadyExistsException"> The value specified as a snapshot identifier is already used by an existing snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotNotFoundException"> The snapshot identifier does not refer to an existing cluster snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotQuotaExceededException"> The request would result in the user exceeding the allowed number of cluster snapshots. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSnapshotStateException"> The state of the cluster snapshot is not <code>available</code>, or other accounts are authorized to access the snapshot. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CopyClusterSnapshotAsync(Amazon.Redshift.Model.CopyClusterSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopyClusterSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyClusterSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateCluster(Amazon.Redshift.Model.CreateClusterRequest)"> <summary> Creates a new cluster. To create the cluster in virtual private cloud (VPC), you must provide cluster subnet group name. If you don't provide a cluster subnet group name or the cluster security group parameter, Amazon Redshift creates a non-VPC cluster, it associates the default cluster security group with the cluster. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . </summary> <param name="request">Container for the necessary parameters to execute the CreateCluster service method.</param> <returns>The response from the CreateCluster service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterAlreadyExistsException"> The account already has a cluster with the given identifier. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterQuotaExceededException"> The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupNotFoundException"> The cluster security group name does not refer to an existing cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetGroupNotFoundException"> The cluster subnet group name does not refer to an existing cluster subnet group. </exception> <exception cref="T:Amazon.Redshift.Model.HsmClientCertificateNotFoundException"> There is no Amazon Redshift HSM client certificate with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.HsmConfigurationNotFoundException"> There is no Amazon Redshift HSM configuration with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InsufficientClusterCapacityException"> The number of nodes specified exceeds the allotted capacity of the cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSubnetGroupStateException"> The cluster subnet group cannot be deleted because it is in use. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidElasticIpException"> The Elastic IP (EIP) is invalid or cannot be found. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidSubnetException"> The requested subnet is not valid, or not all of the subnets are in the same VPC. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidVPCNetworkStateException"> The cluster subnet group does not cover all Availability Zones. </exception> <exception cref="T:Amazon.Redshift.Model.LimitExceededException"> The encryption key has exceeded its grant limit in AWS KMS. </exception> <exception cref="T:Amazon.Redshift.Model.NumberOfNodesPerClusterLimitExceededException"> The operation would exceed the number of nodes allowed for a cluster. </exception> <exception cref="T:Amazon.Redshift.Model.NumberOfNodesQuotaExceededException"> The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> <exception cref="T:Amazon.Redshift.Model.UnauthorizedOperationException"> Your account is not authorized to perform the requested operation. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateClusterAsync(Amazon.Redshift.Model.CreateClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateClusterParameterGroup(Amazon.Redshift.Model.CreateClusterParameterGroupRequest)"> <summary> Creates an Amazon Redshift parameter group. <para> Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using <a>ModifyCluster</a>. </para> <para> Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateClusterParameterGroup service method.</param> <returns>The response from the CreateClusterParameterGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupAlreadyExistsException"> A cluster parameter group with the same name already exists. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupQuotaExceededException"> The request would result in the user exceeding the allowed number of cluster parameter groups. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateClusterParameterGroupAsync(Amazon.Redshift.Model.CreateClusterParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateClusterParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateClusterParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateClusterSecurityGroup(Amazon.Redshift.Model.CreateClusterSecurityGroupRequest)"> <summary> Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters. <para> For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateClusterSecurityGroup service method.</param> <returns>The response from the CreateClusterSecurityGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupAlreadyExistsException"> A cluster security group with the same name already exists. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupQuotaExceededException"> The request would result in the user exceeding the allowed number of cluster security groups. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateClusterSecurityGroupAsync(Amazon.Redshift.Model.CreateClusterSecurityGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateClusterSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateClusterSecurityGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateClusterSnapshot(Amazon.Redshift.Model.CreateClusterSnapshotRequest)"> <summary> Creates a manual snapshot of the specified cluster. The cluster must be in the <code>available</code> state. <para> For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateClusterSnapshot service method.</param> <returns>The response from the CreateClusterSnapshot service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotAlreadyExistsException"> The value specified as a snapshot identifier is already used by an existing snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotQuotaExceededException"> The request would result in the user exceeding the allowed number of cluster snapshots. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterStateException"> The specified cluster is not in the <code>available</code> state. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateClusterSnapshotAsync(Amazon.Redshift.Model.CreateClusterSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateClusterSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateClusterSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateClusterSubnetGroup(Amazon.Redshift.Model.CreateClusterSubnetGroupRequest)"> <summary> Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group. <para> For information about subnet groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-cluster-subnet-groups.html">Amazon Redshift Cluster Subnet Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateClusterSubnetGroup service method.</param> <returns>The response from the CreateClusterSubnetGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetGroupAlreadyExistsException"> A <i>ClusterSubnetGroupName</i> is already used by an existing cluster subnet group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetGroupQuotaExceededException"> The request would result in user exceeding the allowed number of cluster subnet groups. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetQuotaExceededException"> The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidSubnetException"> The requested subnet is not valid, or not all of the subnets are in the same VPC. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> <exception cref="T:Amazon.Redshift.Model.UnauthorizedOperationException"> Your account is not authorized to perform the requested operation. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateClusterSubnetGroupAsync(Amazon.Redshift.Model.CreateClusterSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateClusterSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateClusterSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateEventSubscription(Amazon.Redshift.Model.CreateEventSubscriptionRequest)"> <summary> Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. <para> You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters. </para> <para> If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateEventSubscription service method.</param> <returns>The response from the CreateEventSubscription service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.EventSubscriptionQuotaExceededException"> The request would exceed the allowed number of event subscriptions for this account. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.SNSInvalidTopicException"> Amazon SNS has responded that there is a problem with the specified Amazon SNS topic. </exception> <exception cref="T:Amazon.Redshift.Model.SNSNoAuthorizationException"> You do not have permission to publish to the specified Amazon SNS topic. </exception> <exception cref="T:Amazon.Redshift.Model.SNSTopicArnNotFoundException"> An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist. </exception> <exception cref="T:Amazon.Redshift.Model.SourceNotFoundException"> The specified Amazon Redshift event source could not be found. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionAlreadyExistException"> There is already an existing event notification subscription with the specified name. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionCategoryNotFoundException"> The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionEventIdNotFoundException"> An Amazon Redshift event with the specified event ID does not exist. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionSeverityNotFoundException"> The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateEventSubscriptionAsync(Amazon.Redshift.Model.CreateEventSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateEventSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateEventSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateHsmClientCertificate(Amazon.Redshift.Model.CreateHsmClientCertificateRequest)"> <summary> Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases. <para> The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-HSM.html">Hardware Security Modules</a> in the Amazon Redshift Cluster Management Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateHsmClientCertificate service method.</param> <returns>The response from the CreateHsmClientCertificate service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.HsmClientCertificateAlreadyExistsException"> There is already an existing Amazon Redshift HSM client certificate with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.HsmClientCertificateQuotaExceededException"> The quota for HSM client certificates has been reached. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateHsmClientCertificateAsync(Amazon.Redshift.Model.CreateHsmClientCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateHsmClientCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateHsmClientCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateHsmConfiguration(Amazon.Redshift.Model.CreateHsmConfigurationRequest)"> <summary> Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM. <para> In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-HSM.html">Hardware Security Modules</a> in the Amazon Redshift Cluster Management Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateHsmConfiguration service method.</param> <returns>The response from the CreateHsmConfiguration service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.HsmConfigurationAlreadyExistsException"> There is already an existing Amazon Redshift HSM configuration with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.HsmConfigurationQuotaExceededException"> The quota for HSM configurations has been reached. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateHsmConfigurationAsync(Amazon.Redshift.Model.CreateHsmConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateHsmConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateHsmConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateSnapshotCopyGrant(Amazon.Redshift.Model.CreateSnapshotCopyGrantRequest)"> <summary> Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region. <para> For more information about managing snapshot copy grants, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html">Amazon Redshift Database Encryption</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshotCopyGrant service method.</param> <returns>The response from the CreateSnapshotCopyGrant service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.LimitExceededException"> The encryption key has exceeded its grant limit in AWS KMS. </exception> <exception cref="T:Amazon.Redshift.Model.SnapshotCopyGrantAlreadyExistsException"> The snapshot copy grant can't be created because a grant with the same name already exists. </exception> <exception cref="T:Amazon.Redshift.Model.SnapshotCopyGrantQuotaExceededException"> The AWS account has exceeded the maximum number of snapshot copy grants in this region. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateSnapshotCopyGrantAsync(Amazon.Redshift.Model.CreateSnapshotCopyGrantRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSnapshotCopyGrant operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshotCopyGrant operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateTags(Amazon.Redshift.Model.CreateTagsRequest)"> <summary> Adds one or more tags to a specified resource. <para> A resource can have up to 10 tags. If you try to create more than 10 tags for a resource, you will receive an error and the attempt will fail. </para> <para> If you specify a key that already exists for the resource, the value for that key will be updated with the new value. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateTags service method.</param> <returns>The response from the CreateTags service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.ResourceNotFoundException"> The resource could not be found. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.CreateTagsAsync(Amazon.Redshift.Model.CreateTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTags operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteCluster(Amazon.Redshift.Model.DeleteClusterRequest)"> <summary> Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use <a>DescribeClusters</a> to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . <para> If you want to shut down the cluster and retain it for future use, set <i>SkipFinalClusterSnapshot</i> to <code>false</code> and specify a name for <i>FinalClusterSnapshotIdentifier</i>. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster. </para> <para> For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteCluster service method.</param> <returns>The response from the DeleteCluster service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotAlreadyExistsException"> The value specified as a snapshot identifier is already used by an existing snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotQuotaExceededException"> The request would result in the user exceeding the allowed number of cluster snapshots. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterStateException"> The specified cluster is not in the <code>available</code> state. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteClusterAsync(Amazon.Redshift.Model.DeleteClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteClusterParameterGroup(Amazon.Redshift.Model.DeleteClusterParameterGroupRequest)"> <summary> Deletes a specified Amazon Redshift parameter group. <note>You cannot delete a parameter group if it is associated with a cluster.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteClusterParameterGroup service method.</param> <returns>The response from the DeleteClusterParameterGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterParameterGroupStateException"> The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteClusterParameterGroupAsync(Amazon.Redshift.Model.DeleteClusterParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteClusterParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteClusterParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteClusterSecurityGroup(Amazon.Redshift.Model.DeleteClusterSecurityGroupRequest)"> <summary> Deletes an Amazon Redshift security group. <note>You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.</note> <para> For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteClusterSecurityGroup service method.</param> <returns>The response from the DeleteClusterSecurityGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupNotFoundException"> The cluster security group name does not refer to an existing cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSecurityGroupStateException"> The state of the cluster security group is not <code>available</code>. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteClusterSecurityGroupAsync(Amazon.Redshift.Model.DeleteClusterSecurityGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteClusterSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteClusterSecurityGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteClusterSnapshot(Amazon.Redshift.Model.DeleteClusterSnapshotRequest)"> <summary> Deletes the specified manual snapshot. The snapshot must be in the <code>available</code> state, with no other users authorized to access the snapshot. <para> Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteClusterSnapshot service method.</param> <returns>The response from the DeleteClusterSnapshot service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotNotFoundException"> The snapshot identifier does not refer to an existing cluster snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSnapshotStateException"> The state of the cluster snapshot is not <code>available</code>, or other accounts are authorized to access the snapshot. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteClusterSnapshotAsync(Amazon.Redshift.Model.DeleteClusterSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteClusterSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteClusterSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteClusterSubnetGroup(Amazon.Redshift.Model.DeleteClusterSubnetGroupRequest)"> <summary> Deletes the specified cluster subnet group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteClusterSubnetGroup service method.</param> <returns>The response from the DeleteClusterSubnetGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetGroupNotFoundException"> The cluster subnet group name does not refer to an existing cluster subnet group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSubnetGroupStateException"> The cluster subnet group cannot be deleted because it is in use. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSubnetStateException"> The state of the subnet is invalid. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteClusterSubnetGroupAsync(Amazon.Redshift.Model.DeleteClusterSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteClusterSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteClusterSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteEventSubscription(Amazon.Redshift.Model.DeleteEventSubscriptionRequest)"> <summary> Deletes an Amazon Redshift event notification subscription. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEventSubscription service method.</param> <returns>The response from the DeleteEventSubscription service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.InvalidSubscriptionStateException"> The subscription request is invalid because it is a duplicate request. This subscription request is already in progress. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionNotFoundException"> An Amazon Redshift event notification subscription with the specified name does not exist. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteEventSubscriptionAsync(Amazon.Redshift.Model.DeleteEventSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteEventSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEventSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteHsmClientCertificate(Amazon.Redshift.Model.DeleteHsmClientCertificateRequest)"> <summary> Deletes the specified HSM client certificate. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHsmClientCertificate service method.</param> <returns>The response from the DeleteHsmClientCertificate service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.HsmClientCertificateNotFoundException"> There is no Amazon Redshift HSM client certificate with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidHsmClientCertificateStateException"> The specified HSM client certificate is not in the <code>available</code> state, or it is still in use by one or more Amazon Redshift clusters. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteHsmClientCertificateAsync(Amazon.Redshift.Model.DeleteHsmClientCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteHsmClientCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHsmClientCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteHsmConfiguration(Amazon.Redshift.Model.DeleteHsmConfigurationRequest)"> <summary> Deletes the specified Amazon Redshift HSM configuration. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHsmConfiguration service method.</param> <returns>The response from the DeleteHsmConfiguration service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.HsmConfigurationNotFoundException"> There is no Amazon Redshift HSM configuration with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidHsmConfigurationStateException"> The specified HSM configuration is not in the <code>available</code> state, or it is still in use by one or more Amazon Redshift clusters. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteHsmConfigurationAsync(Amazon.Redshift.Model.DeleteHsmConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteHsmConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHsmConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteSnapshotCopyGrant(Amazon.Redshift.Model.DeleteSnapshotCopyGrantRequest)"> <summary> Deletes the specified snapshot copy grant. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshotCopyGrant service method.</param> <returns>The response from the DeleteSnapshotCopyGrant service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.InvalidSnapshotCopyGrantStateException"> The snapshot copy grant can't be deleted because it is used by one or more clusters. </exception> <exception cref="T:Amazon.Redshift.Model.SnapshotCopyGrantNotFoundException"> The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteSnapshotCopyGrantAsync(Amazon.Redshift.Model.DeleteSnapshotCopyGrantRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSnapshotCopyGrant operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshotCopyGrant operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteTags(Amazon.Redshift.Model.DeleteTagsRequest)"> <summary> Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags service method.</param> <returns>The response from the DeleteTags service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.ResourceNotFoundException"> The resource could not be found. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DeleteTagsAsync(Amazon.Redshift.Model.DeleteTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterParameterGroups"> <summary> Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group. <para> For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all parameter groups that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <returns>The response from the DescribeClusterParameterGroups service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterParameterGroups(Amazon.Redshift.Model.DescribeClusterParameterGroupsRequest)"> <summary> Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group. <para> For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all parameter groups that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterParameterGroups service method.</param> <returns>The response from the DescribeClusterParameterGroups service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterParameterGroupsAsync(Amazon.Redshift.Model.DescribeClusterParameterGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClusterParameterGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterParameterGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterParameters(Amazon.Redshift.Model.DescribeClusterParametersRequest)"> <summary> Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on. <para> You can specify <i>source</i> filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from <a>ModifyClusterParameterGroup</a>, you can specify <i>source</i> equal to <i>user</i>. </para> <para> For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterParameters service method.</param> <returns>The response from the DescribeClusterParameters service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterParametersAsync(Amazon.Redshift.Model.DescribeClusterParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClusterParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusters"> <summary> Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all clusters that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <returns>The response from the DescribeClusters service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusters(Amazon.Redshift.Model.DescribeClustersRequest)"> <summary> Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all clusters that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusters service method.</param> <returns>The response from the DescribeClusters service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClustersAsync(Amazon.Redshift.Model.DescribeClustersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterSecurityGroups"> <summary> Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group. <para> For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all security groups that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <returns>The response from the DescribeClusterSecurityGroups service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupNotFoundException"> The cluster security group name does not refer to an existing cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterSecurityGroups(Amazon.Redshift.Model.DescribeClusterSecurityGroupsRequest)"> <summary> Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group. <para> For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all security groups that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterSecurityGroups service method.</param> <returns>The response from the DescribeClusterSecurityGroups service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupNotFoundException"> The cluster security group name does not refer to an existing cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterSecurityGroupsAsync(Amazon.Redshift.Model.DescribeClusterSecurityGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClusterSecurityGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterSecurityGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterSnapshots"> <summary> Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters. </para> <para> If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <returns>The response from the DescribeClusterSnapshots service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotNotFoundException"> The snapshot identifier does not refer to an existing cluster snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterSnapshots(Amazon.Redshift.Model.DescribeClusterSnapshotsRequest)"> <summary> Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters. </para> <para> If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterSnapshots service method.</param> <returns>The response from the DescribeClusterSnapshots service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotNotFoundException"> The snapshot identifier does not refer to an existing cluster snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterSnapshotsAsync(Amazon.Redshift.Model.DescribeClusterSnapshotsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClusterSnapshots operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterSnapshots operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterSubnetGroups"> <summary> Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all subnet groups that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <returns>The response from the DescribeClusterSubnetGroups service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetGroupNotFoundException"> The cluster subnet group name does not refer to an existing cluster subnet group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterSubnetGroups(Amazon.Redshift.Model.DescribeClusterSubnetGroupsRequest)"> <summary> Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all subnet groups that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterSubnetGroups service method.</param> <returns>The response from the DescribeClusterSubnetGroups service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetGroupNotFoundException"> The cluster subnet group name does not refer to an existing cluster subnet group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterSubnetGroupsAsync(Amazon.Redshift.Model.DescribeClusterSubnetGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClusterSubnetGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterSubnetGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterVersions"> <summary> Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> </summary> <returns>The response from the DescribeClusterVersions service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterVersions(Amazon.Redshift.Model.DescribeClusterVersionsRequest)"> <summary> Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterVersions service method.</param> <returns>The response from the DescribeClusterVersions service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeClusterVersionsAsync(Amazon.Redshift.Model.DescribeClusterVersionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClusterVersions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterVersions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeDefaultClusterParameters(Amazon.Redshift.Model.DescribeDefaultClusterParametersRequest)"> <summary> Returns a list of parameter settings for the specified parameter group family. <para> For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDefaultClusterParameters service method.</param> <returns>The response from the DescribeDefaultClusterParameters service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeDefaultClusterParametersAsync(Amazon.Redshift.Model.DescribeDefaultClusterParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDefaultClusterParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDefaultClusterParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeEventCategories"> <summary> Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html">Amazon Redshift Event Notifications</a>. </summary> <returns>The response from the DescribeEventCategories service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeEventCategories(Amazon.Redshift.Model.DescribeEventCategoriesRequest)"> <summary> Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html">Amazon Redshift Event Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventCategories service method.</param> <returns>The response from the DescribeEventCategories service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeEventCategoriesAsync(Amazon.Redshift.Model.DescribeEventCategoriesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEventCategories operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventCategories operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeEvents"> <summary> Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. </summary> <returns>The response from the DescribeEvents service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeEvents(Amazon.Redshift.Model.DescribeEventsRequest)"> <summary> Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents service method.</param> <returns>The response from the DescribeEvents service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeEventsAsync(Amazon.Redshift.Model.DescribeEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeEventSubscriptions"> <summary> Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account. If you specify a subscription name, lists the description for that subscription. </summary> <returns>The response from the DescribeEventSubscriptions service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.SubscriptionNotFoundException"> An Amazon Redshift event notification subscription with the specified name does not exist. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeEventSubscriptions(Amazon.Redshift.Model.DescribeEventSubscriptionsRequest)"> <summary> Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account. If you specify a subscription name, lists the description for that subscription. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventSubscriptions service method.</param> <returns>The response from the DescribeEventSubscriptions service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.SubscriptionNotFoundException"> An Amazon Redshift event notification subscription with the specified name does not exist. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeEventSubscriptionsAsync(Amazon.Redshift.Model.DescribeEventSubscriptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEventSubscriptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventSubscriptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeHsmClientCertificates"> <summary> Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all HSM client certificates that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <returns>The response from the DescribeHsmClientCertificates service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.HsmClientCertificateNotFoundException"> There is no Amazon Redshift HSM client certificate with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeHsmClientCertificates(Amazon.Redshift.Model.DescribeHsmClientCertificatesRequest)"> <summary> Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all HSM client certificates that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeHsmClientCertificates service method.</param> <returns>The response from the DescribeHsmClientCertificates service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.HsmClientCertificateNotFoundException"> There is no Amazon Redshift HSM client certificate with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeHsmClientCertificatesAsync(Amazon.Redshift.Model.DescribeHsmClientCertificatesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeHsmClientCertificates operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHsmClientCertificates operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeHsmConfigurations"> <summary> Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all HSM connections that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <returns>The response from the DescribeHsmConfigurations service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.HsmConfigurationNotFoundException"> There is no Amazon Redshift HSM configuration with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeHsmConfigurations(Amazon.Redshift.Model.DescribeHsmConfigurationsRequest)"> <summary> Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all HSM connections that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeHsmConfigurations service method.</param> <returns>The response from the DescribeHsmConfigurations service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.HsmConfigurationNotFoundException"> There is no Amazon Redshift HSM configuration with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeHsmConfigurationsAsync(Amazon.Redshift.Model.DescribeHsmConfigurationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeHsmConfigurations operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHsmConfigurations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeLoggingStatus(Amazon.Redshift.Model.DescribeLoggingStatusRequest)"> <summary> Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoggingStatus service method.</param> <returns>The response from the DescribeLoggingStatus service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeLoggingStatusAsync(Amazon.Redshift.Model.DescribeLoggingStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLoggingStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoggingStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeOrderableClusterOptions"> <summary> Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> </summary> <returns>The response from the DescribeOrderableClusterOptions service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeOrderableClusterOptions(Amazon.Redshift.Model.DescribeOrderableClusterOptionsRequest)"> <summary> Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> </summary> <param name="request">Container for the necessary parameters to execute the DescribeOrderableClusterOptions service method.</param> <returns>The response from the DescribeOrderableClusterOptions service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeOrderableClusterOptionsAsync(Amazon.Redshift.Model.DescribeOrderableClusterOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeOrderableClusterOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeOrderableClusterOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeReservedNodeOfferings"> <summary> Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to <a>PurchaseReservedNodeOffering</a> to reserve one or more nodes for your Amazon Redshift cluster. <para> For more information about reserved node offerings, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html">Purchasing Reserved Nodes</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <returns>The response from the DescribeReservedNodeOfferings service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ReservedNodeOfferingNotFoundException"> Specified offering does not exist. </exception> <exception cref="T:Amazon.Redshift.Model.UnsupportedOperationException"> The requested operation isn't supported. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeReservedNodeOfferings(Amazon.Redshift.Model.DescribeReservedNodeOfferingsRequest)"> <summary> Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to <a>PurchaseReservedNodeOffering</a> to reserve one or more nodes for your Amazon Redshift cluster. <para> For more information about reserved node offerings, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html">Purchasing Reserved Nodes</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedNodeOfferings service method.</param> <returns>The response from the DescribeReservedNodeOfferings service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ReservedNodeOfferingNotFoundException"> Specified offering does not exist. </exception> <exception cref="T:Amazon.Redshift.Model.UnsupportedOperationException"> The requested operation isn't supported. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeReservedNodeOfferingsAsync(Amazon.Redshift.Model.DescribeReservedNodeOfferingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedNodeOfferings operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedNodeOfferings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeReservedNodes"> <summary> Returns the descriptions of the reserved nodes. </summary> <returns>The response from the DescribeReservedNodes service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ReservedNodeNotFoundException"> The specified reserved compute node not found. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeReservedNodes(Amazon.Redshift.Model.DescribeReservedNodesRequest)"> <summary> Returns the descriptions of the reserved nodes. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedNodes service method.</param> <returns>The response from the DescribeReservedNodes service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ReservedNodeNotFoundException"> The specified reserved compute node not found. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeReservedNodesAsync(Amazon.Redshift.Model.DescribeReservedNodesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedNodes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedNodes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeResize(Amazon.Redshift.Model.DescribeResizeRequest)"> <summary> Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a <code>HTTP 404</code> error is returned. If a resize operation was initiated and completed, the status of the resize remains as <code>SUCCEEDED</code> until the next resize. <para> A resize operation can be requested using <a>ModifyCluster</a> and specifying a different number or type of nodes for the cluster. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeResize service method.</param> <returns>The response from the DescribeResize service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.ResizeNotFoundException"> A resize operation for the specified cluster is not found. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeResizeAsync(Amazon.Redshift.Model.DescribeResizeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeResize operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeResize operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeSnapshotCopyGrants(Amazon.Redshift.Model.DescribeSnapshotCopyGrantsRequest)"> <summary> Returns a list of snapshot copy grants owned by the AWS account in the destination region. <para> For more information about managing snapshot copy grants, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html">Amazon Redshift Database Encryption</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshotCopyGrants service method.</param> <returns>The response from the DescribeSnapshotCopyGrants service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.SnapshotCopyGrantNotFoundException"> The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeSnapshotCopyGrantsAsync(Amazon.Redshift.Model.DescribeSnapshotCopyGrantsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSnapshotCopyGrants operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshotCopyGrants operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeTags(Amazon.Redshift.Model.DescribeTagsRequest)"> <summary> Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on. <para> The following are limitations for <code>DescribeTags</code>: <ul> <li>You cannot specify an ARN and a resource-type value together in the same request.</li> <li>You cannot use the <code>MaxRecords</code> and <code>Marker</code> parameters together with the ARN parameter.</li> <li>The <code>MaxRecords</code> parameter can be a range from 10 to 50 results to return in a request.</li> </ul> </para> <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all resources that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags service method.</param> <returns>The response from the DescribeTags service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.ResourceNotFoundException"> The resource could not be found. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DescribeTagsAsync(Amazon.Redshift.Model.DescribeTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DisableLogging(Amazon.Redshift.Model.DisableLoggingRequest)"> <summary> Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. </summary> <param name="request">Container for the necessary parameters to execute the DisableLogging service method.</param> <returns>The response from the DisableLogging service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DisableLoggingAsync(Amazon.Redshift.Model.DisableLoggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableLogging operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableLogging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DisableSnapshotCopy(Amazon.Redshift.Model.DisableSnapshotCopyRequest)"> <summary> Disables the automatic copying of snapshots from one region to another region for a specified cluster. <para> If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use <a>DeleteSnapshotCopyGrant</a> to delete the grant that grants Amazon Redshift permission to the CMK in the destination region. </para> </summary> <param name="request">Container for the necessary parameters to execute the DisableSnapshotCopy service method.</param> <returns>The response from the DisableSnapshotCopy service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterStateException"> The specified cluster is not in the <code>available</code> state. </exception> <exception cref="T:Amazon.Redshift.Model.SnapshotCopyAlreadyDisabledException"> The cluster already has cross-region snapshot copy disabled. </exception> <exception cref="T:Amazon.Redshift.Model.UnauthorizedOperationException"> Your account is not authorized to perform the requested operation. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.DisableSnapshotCopyAsync(Amazon.Redshift.Model.DisableSnapshotCopyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableSnapshotCopy operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableSnapshotCopy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.EnableLogging(Amazon.Redshift.Model.EnableLoggingRequest)"> <summary> Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. </summary> <param name="request">Container for the necessary parameters to execute the EnableLogging service method.</param> <returns>The response from the EnableLogging service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.BucketNotFoundException"> Could not find the specified S3 bucket. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InsufficientS3BucketPolicyException"> The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling logging. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidS3BucketNameException"> The S3 bucket name is invalid. For more information about naming rules, go to <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html">Bucket Restrictions and Limitations</a> in the Amazon Simple Storage Service (S3) Developer Guide. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidS3KeyPrefixException"> The string specified for the logging S3 key prefix does not comply with the documented constraints. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.EnableLoggingAsync(Amazon.Redshift.Model.EnableLoggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableLogging operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableLogging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.EnableSnapshotCopy(Amazon.Redshift.Model.EnableSnapshotCopyRequest)"> <summary> Enables the automatic copy of snapshots from one region to another region for a specified cluster. </summary> <param name="request">Container for the necessary parameters to execute the EnableSnapshotCopy service method.</param> <returns>The response from the EnableSnapshotCopy service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.CopyToRegionDisabledException"> Cross-region snapshot copy was temporarily disabled. Try your request again. </exception> <exception cref="T:Amazon.Redshift.Model.IncompatibleOrderableOptionsException"> The specified options are incompatible. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterStateException"> The specified cluster is not in the <code>available</code> state. </exception> <exception cref="T:Amazon.Redshift.Model.LimitExceededException"> The encryption key has exceeded its grant limit in AWS KMS. </exception> <exception cref="T:Amazon.Redshift.Model.SnapshotCopyAlreadyEnabledException"> The cluster already has cross-region snapshot copy enabled. </exception> <exception cref="T:Amazon.Redshift.Model.SnapshotCopyGrantNotFoundException"> The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region. </exception> <exception cref="T:Amazon.Redshift.Model.UnauthorizedOperationException"> Your account is not authorized to perform the requested operation. </exception> <exception cref="T:Amazon.Redshift.Model.UnknownSnapshotCopyRegionException"> The specified region is incorrect or does not exist. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.EnableSnapshotCopyAsync(Amazon.Redshift.Model.EnableSnapshotCopyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableSnapshotCopy operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableSnapshotCopy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.ModifyCluster(Amazon.Redshift.Model.ModifyClusterRequest)"> <summary> Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . <para> You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyCluster service method.</param> <returns>The response from the ModifyCluster service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterAlreadyExistsException"> The account already has a cluster with the given identifier. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupNotFoundException"> The cluster security group name does not refer to an existing cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.HsmClientCertificateNotFoundException"> There is no Amazon Redshift HSM client certificate with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.HsmConfigurationNotFoundException"> There is no Amazon Redshift HSM configuration with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InsufficientClusterCapacityException"> The number of nodes specified exceeds the allotted capacity of the cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSecurityGroupStateException"> The state of the cluster security group is not <code>available</code>. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterStateException"> The specified cluster is not in the <code>available</code> state. </exception> <exception cref="T:Amazon.Redshift.Model.LimitExceededException"> The encryption key has exceeded its grant limit in AWS KMS. </exception> <exception cref="T:Amazon.Redshift.Model.NumberOfNodesQuotaExceededException"> The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.UnauthorizedOperationException"> Your account is not authorized to perform the requested operation. </exception> <exception cref="T:Amazon.Redshift.Model.UnsupportedOptionException"> A request option was specified that is not supported. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.ModifyClusterAsync(Amazon.Redshift.Model.ModifyClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.ModifyClusterParameterGroup(Amazon.Redshift.Model.ModifyClusterParameterGroupRequest)"> <summary> Modifies the parameters of a parameter group. <para> For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyClusterParameterGroup service method.</param> <returns>The response from the ModifyClusterParameterGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterParameterGroupStateException"> The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.ModifyClusterParameterGroupAsync(Amazon.Redshift.Model.ModifyClusterParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyClusterParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyClusterParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.ModifyClusterSubnetGroup(Amazon.Redshift.Model.ModifyClusterSubnetGroupRequest)"> <summary> Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets. </summary> <param name="request">Container for the necessary parameters to execute the ModifyClusterSubnetGroup service method.</param> <returns>The response from the ModifyClusterSubnetGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetGroupNotFoundException"> The cluster subnet group name does not refer to an existing cluster subnet group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetQuotaExceededException"> The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidSubnetException"> The requested subnet is not valid, or not all of the subnets are in the same VPC. </exception> <exception cref="T:Amazon.Redshift.Model.SubnetAlreadyInUseException"> A specified subnet is already in use by another cluster. </exception> <exception cref="T:Amazon.Redshift.Model.UnauthorizedOperationException"> Your account is not authorized to perform the requested operation. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.ModifyClusterSubnetGroupAsync(Amazon.Redshift.Model.ModifyClusterSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyClusterSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyClusterSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.ModifyEventSubscription(Amazon.Redshift.Model.ModifyEventSubscriptionRequest)"> <summary> Modifies an existing Amazon Redshift event notification subscription. </summary> <param name="request">Container for the necessary parameters to execute the ModifyEventSubscription service method.</param> <returns>The response from the ModifyEventSubscription service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.InvalidSubscriptionStateException"> The subscription request is invalid because it is a duplicate request. This subscription request is already in progress. </exception> <exception cref="T:Amazon.Redshift.Model.SNSInvalidTopicException"> Amazon SNS has responded that there is a problem with the specified Amazon SNS topic. </exception> <exception cref="T:Amazon.Redshift.Model.SNSNoAuthorizationException"> You do not have permission to publish to the specified Amazon SNS topic. </exception> <exception cref="T:Amazon.Redshift.Model.SNSTopicArnNotFoundException"> An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist. </exception> <exception cref="T:Amazon.Redshift.Model.SourceNotFoundException"> The specified Amazon Redshift event source could not be found. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionCategoryNotFoundException"> The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionEventIdNotFoundException"> An Amazon Redshift event with the specified event ID does not exist. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionNotFoundException"> An Amazon Redshift event notification subscription with the specified name does not exist. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionSeverityNotFoundException"> The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.ModifyEventSubscriptionAsync(Amazon.Redshift.Model.ModifyEventSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyEventSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyEventSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.ModifySnapshotCopyRetentionPeriod(Amazon.Redshift.Model.ModifySnapshotCopyRetentionPeriodRequest)"> <summary> Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region. </summary> <param name="request">Container for the necessary parameters to execute the ModifySnapshotCopyRetentionPeriod service method.</param> <returns>The response from the ModifySnapshotCopyRetentionPeriod service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterStateException"> The specified cluster is not in the <code>available</code> state. </exception> <exception cref="T:Amazon.Redshift.Model.SnapshotCopyDisabledException"> Cross-region snapshot copy was temporarily disabled. Try your request again. </exception> <exception cref="T:Amazon.Redshift.Model.UnauthorizedOperationException"> Your account is not authorized to perform the requested operation. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.ModifySnapshotCopyRetentionPeriodAsync(Amazon.Redshift.Model.ModifySnapshotCopyRetentionPeriodRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifySnapshotCopyRetentionPeriod operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifySnapshotCopyRetentionPeriod operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.PurchaseReservedNodeOffering(Amazon.Redshift.Model.PurchaseReservedNodeOfferingRequest)"> <summary> Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the <a>DescribeReservedNodeOfferings</a> API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve. <para> For more information about reserved node offerings, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html">Purchasing Reserved Nodes</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedNodeOffering service method.</param> <returns>The response from the PurchaseReservedNodeOffering service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ReservedNodeAlreadyExistsException"> User already has a reservation with the given identifier. </exception> <exception cref="T:Amazon.Redshift.Model.ReservedNodeOfferingNotFoundException"> Specified offering does not exist. </exception> <exception cref="T:Amazon.Redshift.Model.ReservedNodeQuotaExceededException"> Request would exceed the user's compute node quota. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.UnsupportedOperationException"> The requested operation isn't supported. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.PurchaseReservedNodeOfferingAsync(Amazon.Redshift.Model.PurchaseReservedNodeOfferingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PurchaseReservedNodeOffering operation. </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedNodeOffering operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.RebootCluster(Amazon.Redshift.Model.RebootClusterRequest)"> <summary> Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to <code>rebooting</code>. A cluster event is created when the reboot is completed. Any pending cluster modifications (see <a>ModifyCluster</a>) are applied at this reboot. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> </summary> <param name="request">Container for the necessary parameters to execute the RebootCluster service method.</param> <returns>The response from the RebootCluster service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterStateException"> The specified cluster is not in the <code>available</code> state. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.RebootClusterAsync(Amazon.Redshift.Model.RebootClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RebootCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the RebootCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.ResetClusterParameterGroup(Amazon.Redshift.Model.ResetClusterParameterGroupRequest)"> <summary> Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the <i>ResetAllParameters</i> parameter. For parameter changes to take effect you must reboot any associated clusters. </summary> <param name="request">Container for the necessary parameters to execute the ResetClusterParameterGroup service method.</param> <returns>The response from the ResetClusterParameterGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterParameterGroupStateException"> The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.ResetClusterParameterGroupAsync(Amazon.Redshift.Model.ResetClusterParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetClusterParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetClusterParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.RestoreFromClusterSnapshot(Amazon.Redshift.Model.RestoreFromClusterSnapshotRequest)"> <summary> Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the <a>ModifyCluster</a> API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore. <para> If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored. </para> <para> For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RestoreFromClusterSnapshot service method.</param> <returns>The response from the RestoreFromClusterSnapshot service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.AccessToSnapshotDeniedException"> The owner of the specified snapshot has not authorized your account to access the snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterAlreadyExistsException"> The account already has a cluster with the given identifier. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterQuotaExceededException"> The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupNotFoundException"> The cluster security group name does not refer to an existing cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotNotFoundException"> The snapshot identifier does not refer to an existing cluster snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetGroupNotFoundException"> The cluster subnet group name does not refer to an existing cluster subnet group. </exception> <exception cref="T:Amazon.Redshift.Model.HsmClientCertificateNotFoundException"> There is no Amazon Redshift HSM client certificate with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.HsmConfigurationNotFoundException"> There is no Amazon Redshift HSM configuration with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InsufficientClusterCapacityException"> The number of nodes specified exceeds the allotted capacity of the cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSnapshotStateException"> The state of the cluster snapshot is not <code>available</code>, or other accounts are authorized to access the snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSubnetGroupStateException"> The cluster subnet group cannot be deleted because it is in use. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidElasticIpException"> The Elastic IP (EIP) is invalid or cannot be found. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidRestoreException"> The restore is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidSubnetException"> The requested subnet is not valid, or not all of the subnets are in the same VPC. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidVPCNetworkStateException"> The cluster subnet group does not cover all Availability Zones. </exception> <exception cref="T:Amazon.Redshift.Model.LimitExceededException"> The encryption key has exceeded its grant limit in AWS KMS. </exception> <exception cref="T:Amazon.Redshift.Model.NumberOfNodesPerClusterLimitExceededException"> The operation would exceed the number of nodes allowed for a cluster. </exception> <exception cref="T:Amazon.Redshift.Model.NumberOfNodesQuotaExceededException"> The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.UnauthorizedOperationException"> Your account is not authorized to perform the requested operation. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.RestoreFromClusterSnapshotAsync(Amazon.Redshift.Model.RestoreFromClusterSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestoreFromClusterSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreFromClusterSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.RevokeClusterSecurityGroupIngress(Amazon.Redshift.Model.RevokeClusterSecurityGroupIngressRequest)"> <summary> Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see <a>AuthorizeClusterSecurityGroupIngress</a>. For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the RevokeClusterSecurityGroupIngress service method.</param> <returns>The response from the RevokeClusterSecurityGroupIngress service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.AuthorizationNotFoundException"> The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupNotFoundException"> The cluster security group name does not refer to an existing cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSecurityGroupStateException"> The state of the cluster security group is not <code>available</code>. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.RevokeClusterSecurityGroupIngressAsync(Amazon.Redshift.Model.RevokeClusterSecurityGroupIngressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RevokeClusterSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeClusterSecurityGroupIngress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.RevokeSnapshotAccess(Amazon.Redshift.Model.RevokeSnapshotAccessRequest)"> <summary> Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion. <para> For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RevokeSnapshotAccess service method.</param> <returns>The response from the RevokeSnapshotAccess service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.AccessToSnapshotDeniedException"> The owner of the specified snapshot has not authorized your account to access the snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.AuthorizationNotFoundException"> The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotNotFoundException"> The snapshot identifier does not refer to an existing cluster snapshot. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.RevokeSnapshotAccessAsync(Amazon.Redshift.Model.RevokeSnapshotAccessRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RevokeSnapshotAccess operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeSnapshotAccess operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.RotateEncryptionKey(Amazon.Redshift.Model.RotateEncryptionKeyRequest)"> <summary> Rotates the encryption keys for a cluster. </summary> <param name="request">Container for the necessary parameters to execute the RotateEncryptionKey service method.</param> <returns>The response from the RotateEncryptionKey service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterStateException"> The specified cluster is not in the <code>available</code> state. </exception> </member> <member name="M:Amazon.Redshift.IAmazonRedshift.RotateEncryptionKeyAsync(Amazon.Redshift.Model.RotateEncryptionKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RotateEncryptionKey operation. </summary> <param name="request">Container for the necessary parameters to execute the RotateEncryptionKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.#ctor"> <summary> Constructs AmazonRedshiftClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonRedshiftClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.#ctor(Amazon.Redshift.AmazonRedshiftConfig)"> <summary> Constructs AmazonRedshiftClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonRedshiftClient Configuration Object</param> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonRedshiftClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonRedshiftClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.Redshift.AmazonRedshiftConfig)"> <summary> Constructs AmazonRedshiftClient with AWS Credentials and an AmazonRedshiftClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonRedshiftClient Configuration Object</param> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonRedshiftClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonRedshiftClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.#ctor(System.String,System.String,Amazon.Redshift.AmazonRedshiftConfig)"> <summary> Constructs AmazonRedshiftClient with AWS Access Key ID, AWS Secret Key and an AmazonRedshiftClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonRedshiftClient Configuration Object</param> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonRedshiftClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonRedshiftClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.#ctor(System.String,System.String,System.String,Amazon.Redshift.AmazonRedshiftConfig)"> <summary> Constructs AmazonRedshiftClient with AWS Access Key ID, AWS Secret Key and an AmazonRedshiftClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonRedshiftClient Configuration Object</param> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.AuthorizeClusterSecurityGroupIngress(Amazon.Redshift.Model.AuthorizeClusterSecurityGroupIngressRequest)"> <summary> Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR) IP address range or an EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group. <note> The EC2 security group must be defined in the AWS region where the cluster resides. </note> <para> For an overview of CIDR blocks, see the Wikipedia article on <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>. </para> <para> You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Working with Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeClusterSecurityGroupIngress service method.</param> <returns>The response from the AuthorizeClusterSecurityGroupIngress service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.AuthorizationAlreadyExistsException"> The specified CIDR block or EC2 security group is already authorized for the specified cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.AuthorizationQuotaExceededException"> The authorization quota for the cluster security group has been reached. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupNotFoundException"> The cluster security group name does not refer to an existing cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSecurityGroupStateException"> The state of the cluster security group is not <code>available</code>. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.AuthorizeClusterSecurityGroupIngressAsync(Amazon.Redshift.Model.AuthorizeClusterSecurityGroupIngressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AuthorizeClusterSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeClusterSecurityGroupIngress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.AuthorizeSnapshotAccess(Amazon.Redshift.Model.AuthorizeSnapshotAccessRequest)"> <summary> Authorizes the specified AWS customer account to restore the specified snapshot. <para> For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSnapshotAccess service method.</param> <returns>The response from the AuthorizeSnapshotAccess service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.AuthorizationAlreadyExistsException"> The specified CIDR block or EC2 security group is already authorized for the specified cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.AuthorizationQuotaExceededException"> The authorization quota for the cluster security group has been reached. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotNotFoundException"> The snapshot identifier does not refer to an existing cluster snapshot. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.AuthorizeSnapshotAccessAsync(Amazon.Redshift.Model.AuthorizeSnapshotAccessRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AuthorizeSnapshotAccess operation. </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSnapshotAccess operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CopyClusterSnapshot(Amazon.Redshift.Model.CopyClusterSnapshotRequest)"> <summary> Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state. <para> When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them. </para> <para> For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CopyClusterSnapshot service method.</param> <returns>The response from the CopyClusterSnapshot service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotAlreadyExistsException"> The value specified as a snapshot identifier is already used by an existing snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotNotFoundException"> The snapshot identifier does not refer to an existing cluster snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotQuotaExceededException"> The request would result in the user exceeding the allowed number of cluster snapshots. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSnapshotStateException"> The state of the cluster snapshot is not <code>available</code>, or other accounts are authorized to access the snapshot. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CopyClusterSnapshotAsync(Amazon.Redshift.Model.CopyClusterSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopyClusterSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyClusterSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateCluster(Amazon.Redshift.Model.CreateClusterRequest)"> <summary> Creates a new cluster. To create the cluster in virtual private cloud (VPC), you must provide cluster subnet group name. If you don't provide a cluster subnet group name or the cluster security group parameter, Amazon Redshift creates a non-VPC cluster, it associates the default cluster security group with the cluster. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . </summary> <param name="request">Container for the necessary parameters to execute the CreateCluster service method.</param> <returns>The response from the CreateCluster service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterAlreadyExistsException"> The account already has a cluster with the given identifier. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterQuotaExceededException"> The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupNotFoundException"> The cluster security group name does not refer to an existing cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetGroupNotFoundException"> The cluster subnet group name does not refer to an existing cluster subnet group. </exception> <exception cref="T:Amazon.Redshift.Model.HsmClientCertificateNotFoundException"> There is no Amazon Redshift HSM client certificate with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.HsmConfigurationNotFoundException"> There is no Amazon Redshift HSM configuration with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InsufficientClusterCapacityException"> The number of nodes specified exceeds the allotted capacity of the cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSubnetGroupStateException"> The cluster subnet group cannot be deleted because it is in use. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidElasticIpException"> The Elastic IP (EIP) is invalid or cannot be found. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidSubnetException"> The requested subnet is not valid, or not all of the subnets are in the same VPC. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidVPCNetworkStateException"> The cluster subnet group does not cover all Availability Zones. </exception> <exception cref="T:Amazon.Redshift.Model.LimitExceededException"> The encryption key has exceeded its grant limit in AWS KMS. </exception> <exception cref="T:Amazon.Redshift.Model.NumberOfNodesPerClusterLimitExceededException"> The operation would exceed the number of nodes allowed for a cluster. </exception> <exception cref="T:Amazon.Redshift.Model.NumberOfNodesQuotaExceededException"> The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> <exception cref="T:Amazon.Redshift.Model.UnauthorizedOperationException"> Your account is not authorized to perform the requested operation. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateClusterAsync(Amazon.Redshift.Model.CreateClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateClusterParameterGroup(Amazon.Redshift.Model.CreateClusterParameterGroupRequest)"> <summary> Creates an Amazon Redshift parameter group. <para> Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using <a>ModifyCluster</a>. </para> <para> Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateClusterParameterGroup service method.</param> <returns>The response from the CreateClusterParameterGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupAlreadyExistsException"> A cluster parameter group with the same name already exists. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupQuotaExceededException"> The request would result in the user exceeding the allowed number of cluster parameter groups. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateClusterParameterGroupAsync(Amazon.Redshift.Model.CreateClusterParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateClusterParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateClusterParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateClusterSecurityGroup(Amazon.Redshift.Model.CreateClusterSecurityGroupRequest)"> <summary> Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters. <para> For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateClusterSecurityGroup service method.</param> <returns>The response from the CreateClusterSecurityGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupAlreadyExistsException"> A cluster security group with the same name already exists. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupQuotaExceededException"> The request would result in the user exceeding the allowed number of cluster security groups. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateClusterSecurityGroupAsync(Amazon.Redshift.Model.CreateClusterSecurityGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateClusterSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateClusterSecurityGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateClusterSnapshot(Amazon.Redshift.Model.CreateClusterSnapshotRequest)"> <summary> Creates a manual snapshot of the specified cluster. The cluster must be in the <code>available</code> state. <para> For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateClusterSnapshot service method.</param> <returns>The response from the CreateClusterSnapshot service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotAlreadyExistsException"> The value specified as a snapshot identifier is already used by an existing snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotQuotaExceededException"> The request would result in the user exceeding the allowed number of cluster snapshots. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterStateException"> The specified cluster is not in the <code>available</code> state. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateClusterSnapshotAsync(Amazon.Redshift.Model.CreateClusterSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateClusterSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateClusterSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateClusterSubnetGroup(Amazon.Redshift.Model.CreateClusterSubnetGroupRequest)"> <summary> Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group. <para> For information about subnet groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-cluster-subnet-groups.html">Amazon Redshift Cluster Subnet Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateClusterSubnetGroup service method.</param> <returns>The response from the CreateClusterSubnetGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetGroupAlreadyExistsException"> A <i>ClusterSubnetGroupName</i> is already used by an existing cluster subnet group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetGroupQuotaExceededException"> The request would result in user exceeding the allowed number of cluster subnet groups. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetQuotaExceededException"> The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidSubnetException"> The requested subnet is not valid, or not all of the subnets are in the same VPC. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> <exception cref="T:Amazon.Redshift.Model.UnauthorizedOperationException"> Your account is not authorized to perform the requested operation. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateClusterSubnetGroupAsync(Amazon.Redshift.Model.CreateClusterSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateClusterSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateClusterSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateEventSubscription(Amazon.Redshift.Model.CreateEventSubscriptionRequest)"> <summary> Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. <para> You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters. </para> <para> If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateEventSubscription service method.</param> <returns>The response from the CreateEventSubscription service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.EventSubscriptionQuotaExceededException"> The request would exceed the allowed number of event subscriptions for this account. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.SNSInvalidTopicException"> Amazon SNS has responded that there is a problem with the specified Amazon SNS topic. </exception> <exception cref="T:Amazon.Redshift.Model.SNSNoAuthorizationException"> You do not have permission to publish to the specified Amazon SNS topic. </exception> <exception cref="T:Amazon.Redshift.Model.SNSTopicArnNotFoundException"> An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist. </exception> <exception cref="T:Amazon.Redshift.Model.SourceNotFoundException"> The specified Amazon Redshift event source could not be found. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionAlreadyExistException"> There is already an existing event notification subscription with the specified name. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionCategoryNotFoundException"> The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionEventIdNotFoundException"> An Amazon Redshift event with the specified event ID does not exist. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionSeverityNotFoundException"> The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateEventSubscriptionAsync(Amazon.Redshift.Model.CreateEventSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateEventSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateEventSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateHsmClientCertificate(Amazon.Redshift.Model.CreateHsmClientCertificateRequest)"> <summary> Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases. <para> The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-HSM.html">Hardware Security Modules</a> in the Amazon Redshift Cluster Management Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateHsmClientCertificate service method.</param> <returns>The response from the CreateHsmClientCertificate service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.HsmClientCertificateAlreadyExistsException"> There is already an existing Amazon Redshift HSM client certificate with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.HsmClientCertificateQuotaExceededException"> The quota for HSM client certificates has been reached. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateHsmClientCertificateAsync(Amazon.Redshift.Model.CreateHsmClientCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateHsmClientCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateHsmClientCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateHsmConfiguration(Amazon.Redshift.Model.CreateHsmConfigurationRequest)"> <summary> Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM. <para> In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-HSM.html">Hardware Security Modules</a> in the Amazon Redshift Cluster Management Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateHsmConfiguration service method.</param> <returns>The response from the CreateHsmConfiguration service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.HsmConfigurationAlreadyExistsException"> There is already an existing Amazon Redshift HSM configuration with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.HsmConfigurationQuotaExceededException"> The quota for HSM configurations has been reached. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateHsmConfigurationAsync(Amazon.Redshift.Model.CreateHsmConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateHsmConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateHsmConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateSnapshotCopyGrant(Amazon.Redshift.Model.CreateSnapshotCopyGrantRequest)"> <summary> Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region. <para> For more information about managing snapshot copy grants, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html">Amazon Redshift Database Encryption</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshotCopyGrant service method.</param> <returns>The response from the CreateSnapshotCopyGrant service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.LimitExceededException"> The encryption key has exceeded its grant limit in AWS KMS. </exception> <exception cref="T:Amazon.Redshift.Model.SnapshotCopyGrantAlreadyExistsException"> The snapshot copy grant can't be created because a grant with the same name already exists. </exception> <exception cref="T:Amazon.Redshift.Model.SnapshotCopyGrantQuotaExceededException"> The AWS account has exceeded the maximum number of snapshot copy grants in this region. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateSnapshotCopyGrantAsync(Amazon.Redshift.Model.CreateSnapshotCopyGrantRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSnapshotCopyGrant operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshotCopyGrant operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateTags(Amazon.Redshift.Model.CreateTagsRequest)"> <summary> Adds one or more tags to a specified resource. <para> A resource can have up to 10 tags. If you try to create more than 10 tags for a resource, you will receive an error and the attempt will fail. </para> <para> If you specify a key that already exists for the resource, the value for that key will be updated with the new value. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateTags service method.</param> <returns>The response from the CreateTags service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.ResourceNotFoundException"> The resource could not be found. </exception> <exception cref="T:Amazon.Redshift.Model.TagLimitExceededException"> The request exceeds the limit of 10 tags for the resource. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.CreateTagsAsync(Amazon.Redshift.Model.CreateTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTags operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteCluster(Amazon.Redshift.Model.DeleteClusterRequest)"> <summary> Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use <a>DescribeClusters</a> to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . <para> If you want to shut down the cluster and retain it for future use, set <i>SkipFinalClusterSnapshot</i> to <code>false</code> and specify a name for <i>FinalClusterSnapshotIdentifier</i>. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster. </para> <para> For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteCluster service method.</param> <returns>The response from the DeleteCluster service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotAlreadyExistsException"> The value specified as a snapshot identifier is already used by an existing snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotQuotaExceededException"> The request would result in the user exceeding the allowed number of cluster snapshots. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterStateException"> The specified cluster is not in the <code>available</code> state. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteClusterAsync(Amazon.Redshift.Model.DeleteClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteClusterParameterGroup(Amazon.Redshift.Model.DeleteClusterParameterGroupRequest)"> <summary> Deletes a specified Amazon Redshift parameter group. <note>You cannot delete a parameter group if it is associated with a cluster.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteClusterParameterGroup service method.</param> <returns>The response from the DeleteClusterParameterGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterParameterGroupStateException"> The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteClusterParameterGroupAsync(Amazon.Redshift.Model.DeleteClusterParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteClusterParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteClusterParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteClusterSecurityGroup(Amazon.Redshift.Model.DeleteClusterSecurityGroupRequest)"> <summary> Deletes an Amazon Redshift security group. <note>You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.</note> <para> For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteClusterSecurityGroup service method.</param> <returns>The response from the DeleteClusterSecurityGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupNotFoundException"> The cluster security group name does not refer to an existing cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSecurityGroupStateException"> The state of the cluster security group is not <code>available</code>. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteClusterSecurityGroupAsync(Amazon.Redshift.Model.DeleteClusterSecurityGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteClusterSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteClusterSecurityGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteClusterSnapshot(Amazon.Redshift.Model.DeleteClusterSnapshotRequest)"> <summary> Deletes the specified manual snapshot. The snapshot must be in the <code>available</code> state, with no other users authorized to access the snapshot. <para> Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteClusterSnapshot service method.</param> <returns>The response from the DeleteClusterSnapshot service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotNotFoundException"> The snapshot identifier does not refer to an existing cluster snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSnapshotStateException"> The state of the cluster snapshot is not <code>available</code>, or other accounts are authorized to access the snapshot. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteClusterSnapshotAsync(Amazon.Redshift.Model.DeleteClusterSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteClusterSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteClusterSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteClusterSubnetGroup(Amazon.Redshift.Model.DeleteClusterSubnetGroupRequest)"> <summary> Deletes the specified cluster subnet group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteClusterSubnetGroup service method.</param> <returns>The response from the DeleteClusterSubnetGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetGroupNotFoundException"> The cluster subnet group name does not refer to an existing cluster subnet group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSubnetGroupStateException"> The cluster subnet group cannot be deleted because it is in use. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSubnetStateException"> The state of the subnet is invalid. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteClusterSubnetGroupAsync(Amazon.Redshift.Model.DeleteClusterSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteClusterSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteClusterSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteEventSubscription(Amazon.Redshift.Model.DeleteEventSubscriptionRequest)"> <summary> Deletes an Amazon Redshift event notification subscription. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEventSubscription service method.</param> <returns>The response from the DeleteEventSubscription service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.InvalidSubscriptionStateException"> The subscription request is invalid because it is a duplicate request. This subscription request is already in progress. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionNotFoundException"> An Amazon Redshift event notification subscription with the specified name does not exist. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteEventSubscriptionAsync(Amazon.Redshift.Model.DeleteEventSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteEventSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEventSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteHsmClientCertificate(Amazon.Redshift.Model.DeleteHsmClientCertificateRequest)"> <summary> Deletes the specified HSM client certificate. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHsmClientCertificate service method.</param> <returns>The response from the DeleteHsmClientCertificate service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.HsmClientCertificateNotFoundException"> There is no Amazon Redshift HSM client certificate with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidHsmClientCertificateStateException"> The specified HSM client certificate is not in the <code>available</code> state, or it is still in use by one or more Amazon Redshift clusters. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteHsmClientCertificateAsync(Amazon.Redshift.Model.DeleteHsmClientCertificateRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteHsmClientCertificate operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHsmClientCertificate operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteHsmConfiguration(Amazon.Redshift.Model.DeleteHsmConfigurationRequest)"> <summary> Deletes the specified Amazon Redshift HSM configuration. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHsmConfiguration service method.</param> <returns>The response from the DeleteHsmConfiguration service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.HsmConfigurationNotFoundException"> There is no Amazon Redshift HSM configuration with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidHsmConfigurationStateException"> The specified HSM configuration is not in the <code>available</code> state, or it is still in use by one or more Amazon Redshift clusters. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteHsmConfigurationAsync(Amazon.Redshift.Model.DeleteHsmConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteHsmConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHsmConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteSnapshotCopyGrant(Amazon.Redshift.Model.DeleteSnapshotCopyGrantRequest)"> <summary> Deletes the specified snapshot copy grant. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshotCopyGrant service method.</param> <returns>The response from the DeleteSnapshotCopyGrant service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.InvalidSnapshotCopyGrantStateException"> The snapshot copy grant can't be deleted because it is used by one or more clusters. </exception> <exception cref="T:Amazon.Redshift.Model.SnapshotCopyGrantNotFoundException"> The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteSnapshotCopyGrantAsync(Amazon.Redshift.Model.DeleteSnapshotCopyGrantRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSnapshotCopyGrant operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshotCopyGrant operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteTags(Amazon.Redshift.Model.DeleteTagsRequest)"> <summary> Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags service method.</param> <returns>The response from the DeleteTags service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.ResourceNotFoundException"> The resource could not be found. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DeleteTagsAsync(Amazon.Redshift.Model.DeleteTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterParameterGroups"> <summary> Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group. <para> For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all parameter groups that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <returns>The response from the DescribeClusterParameterGroups service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterParameterGroups(Amazon.Redshift.Model.DescribeClusterParameterGroupsRequest)"> <summary> Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group. <para> For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all parameter groups that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterParameterGroups service method.</param> <returns>The response from the DescribeClusterParameterGroups service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterParameterGroupsAsync(Amazon.Redshift.Model.DescribeClusterParameterGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClusterParameterGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterParameterGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterParameters(Amazon.Redshift.Model.DescribeClusterParametersRequest)"> <summary> Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on. <para> You can specify <i>source</i> filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from <a>ModifyClusterParameterGroup</a>, you can specify <i>source</i> equal to <i>user</i>. </para> <para> For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterParameters service method.</param> <returns>The response from the DescribeClusterParameters service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterParametersAsync(Amazon.Redshift.Model.DescribeClusterParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClusterParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusters"> <summary> Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all clusters that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <returns>The response from the DescribeClusters service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusters(Amazon.Redshift.Model.DescribeClustersRequest)"> <summary> Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all clusters that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusters service method.</param> <returns>The response from the DescribeClusters service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClustersAsync(Amazon.Redshift.Model.DescribeClustersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterSecurityGroups"> <summary> Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group. <para> For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all security groups that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <returns>The response from the DescribeClusterSecurityGroups service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupNotFoundException"> The cluster security group name does not refer to an existing cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterSecurityGroups(Amazon.Redshift.Model.DescribeClusterSecurityGroupsRequest)"> <summary> Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group. <para> For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all security groups that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterSecurityGroups service method.</param> <returns>The response from the DescribeClusterSecurityGroups service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupNotFoundException"> The cluster security group name does not refer to an existing cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterSecurityGroupsAsync(Amazon.Redshift.Model.DescribeClusterSecurityGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClusterSecurityGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterSecurityGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterSnapshots"> <summary> Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters. </para> <para> If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <returns>The response from the DescribeClusterSnapshots service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotNotFoundException"> The snapshot identifier does not refer to an existing cluster snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterSnapshots(Amazon.Redshift.Model.DescribeClusterSnapshotsRequest)"> <summary> Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters. </para> <para> If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterSnapshots service method.</param> <returns>The response from the DescribeClusterSnapshots service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotNotFoundException"> The snapshot identifier does not refer to an existing cluster snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterSnapshotsAsync(Amazon.Redshift.Model.DescribeClusterSnapshotsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClusterSnapshots operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterSnapshots operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterSubnetGroups"> <summary> Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all subnet groups that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <returns>The response from the DescribeClusterSubnetGroups service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetGroupNotFoundException"> The cluster subnet group name does not refer to an existing cluster subnet group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterSubnetGroups(Amazon.Redshift.Model.DescribeClusterSubnetGroupsRequest)"> <summary> Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all subnet groups that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterSubnetGroups service method.</param> <returns>The response from the DescribeClusterSubnetGroups service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetGroupNotFoundException"> The cluster subnet group name does not refer to an existing cluster subnet group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterSubnetGroupsAsync(Amazon.Redshift.Model.DescribeClusterSubnetGroupsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClusterSubnetGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterSubnetGroups operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterVersions"> <summary> Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> </summary> <returns>The response from the DescribeClusterVersions service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterVersions(Amazon.Redshift.Model.DescribeClusterVersionsRequest)"> <summary> Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterVersions service method.</param> <returns>The response from the DescribeClusterVersions service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeClusterVersionsAsync(Amazon.Redshift.Model.DescribeClusterVersionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeClusterVersions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusterVersions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeDefaultClusterParameters(Amazon.Redshift.Model.DescribeDefaultClusterParametersRequest)"> <summary> Returns a list of parameter settings for the specified parameter group family. <para> For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDefaultClusterParameters service method.</param> <returns>The response from the DescribeDefaultClusterParameters service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeDefaultClusterParametersAsync(Amazon.Redshift.Model.DescribeDefaultClusterParametersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDefaultClusterParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDefaultClusterParameters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeEventCategories"> <summary> Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html">Amazon Redshift Event Notifications</a>. </summary> <returns>The response from the DescribeEventCategories service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeEventCategories(Amazon.Redshift.Model.DescribeEventCategoriesRequest)"> <summary> Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html">Amazon Redshift Event Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventCategories service method.</param> <returns>The response from the DescribeEventCategories service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeEventCategoriesAsync(Amazon.Redshift.Model.DescribeEventCategoriesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEventCategories operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventCategories operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeEvents"> <summary> Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. </summary> <returns>The response from the DescribeEvents service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeEvents(Amazon.Redshift.Model.DescribeEventsRequest)"> <summary> Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents service method.</param> <returns>The response from the DescribeEvents service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeEventsAsync(Amazon.Redshift.Model.DescribeEventsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeEventSubscriptions"> <summary> Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account. If you specify a subscription name, lists the description for that subscription. </summary> <returns>The response from the DescribeEventSubscriptions service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.SubscriptionNotFoundException"> An Amazon Redshift event notification subscription with the specified name does not exist. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeEventSubscriptions(Amazon.Redshift.Model.DescribeEventSubscriptionsRequest)"> <summary> Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account. If you specify a subscription name, lists the description for that subscription. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventSubscriptions service method.</param> <returns>The response from the DescribeEventSubscriptions service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.SubscriptionNotFoundException"> An Amazon Redshift event notification subscription with the specified name does not exist. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeEventSubscriptionsAsync(Amazon.Redshift.Model.DescribeEventSubscriptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeEventSubscriptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventSubscriptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeHsmClientCertificates"> <summary> Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all HSM client certificates that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <returns>The response from the DescribeHsmClientCertificates service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.HsmClientCertificateNotFoundException"> There is no Amazon Redshift HSM client certificate with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeHsmClientCertificates(Amazon.Redshift.Model.DescribeHsmClientCertificatesRequest)"> <summary> Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all HSM client certificates that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeHsmClientCertificates service method.</param> <returns>The response from the DescribeHsmClientCertificates service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.HsmClientCertificateNotFoundException"> There is no Amazon Redshift HSM client certificate with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeHsmClientCertificatesAsync(Amazon.Redshift.Model.DescribeHsmClientCertificatesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeHsmClientCertificates operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHsmClientCertificates operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeHsmConfigurations"> <summary> Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all HSM connections that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <returns>The response from the DescribeHsmConfigurations service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.HsmConfigurationNotFoundException"> There is no Amazon Redshift HSM configuration with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeHsmConfigurations(Amazon.Redshift.Model.DescribeHsmConfigurationsRequest)"> <summary> Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all HSM connections that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeHsmConfigurations service method.</param> <returns>The response from the DescribeHsmConfigurations service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.HsmConfigurationNotFoundException"> There is no Amazon Redshift HSM configuration with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeHsmConfigurationsAsync(Amazon.Redshift.Model.DescribeHsmConfigurationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeHsmConfigurations operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHsmConfigurations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeLoggingStatus(Amazon.Redshift.Model.DescribeLoggingStatusRequest)"> <summary> Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoggingStatus service method.</param> <returns>The response from the DescribeLoggingStatus service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeLoggingStatusAsync(Amazon.Redshift.Model.DescribeLoggingStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeLoggingStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoggingStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeOrderableClusterOptions"> <summary> Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> </summary> <returns>The response from the DescribeOrderableClusterOptions service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeOrderableClusterOptions(Amazon.Redshift.Model.DescribeOrderableClusterOptionsRequest)"> <summary> Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> </summary> <param name="request">Container for the necessary parameters to execute the DescribeOrderableClusterOptions service method.</param> <returns>The response from the DescribeOrderableClusterOptions service method, as returned by Redshift.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeOrderableClusterOptionsAsync(Amazon.Redshift.Model.DescribeOrderableClusterOptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeOrderableClusterOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeOrderableClusterOptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeReservedNodeOfferings"> <summary> Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to <a>PurchaseReservedNodeOffering</a> to reserve one or more nodes for your Amazon Redshift cluster. <para> For more information about reserved node offerings, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html">Purchasing Reserved Nodes</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <returns>The response from the DescribeReservedNodeOfferings service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ReservedNodeOfferingNotFoundException"> Specified offering does not exist. </exception> <exception cref="T:Amazon.Redshift.Model.UnsupportedOperationException"> The requested operation isn't supported. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeReservedNodeOfferings(Amazon.Redshift.Model.DescribeReservedNodeOfferingsRequest)"> <summary> Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to <a>PurchaseReservedNodeOffering</a> to reserve one or more nodes for your Amazon Redshift cluster. <para> For more information about reserved node offerings, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html">Purchasing Reserved Nodes</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedNodeOfferings service method.</param> <returns>The response from the DescribeReservedNodeOfferings service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ReservedNodeOfferingNotFoundException"> Specified offering does not exist. </exception> <exception cref="T:Amazon.Redshift.Model.UnsupportedOperationException"> The requested operation isn't supported. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeReservedNodeOfferingsAsync(Amazon.Redshift.Model.DescribeReservedNodeOfferingsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedNodeOfferings operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedNodeOfferings operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeReservedNodes"> <summary> Returns the descriptions of the reserved nodes. </summary> <returns>The response from the DescribeReservedNodes service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ReservedNodeNotFoundException"> The specified reserved compute node not found. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeReservedNodes(Amazon.Redshift.Model.DescribeReservedNodesRequest)"> <summary> Returns the descriptions of the reserved nodes. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedNodes service method.</param> <returns>The response from the DescribeReservedNodes service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ReservedNodeNotFoundException"> The specified reserved compute node not found. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeReservedNodesAsync(Amazon.Redshift.Model.DescribeReservedNodesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReservedNodes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedNodes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeResize(Amazon.Redshift.Model.DescribeResizeRequest)"> <summary> Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a <code>HTTP 404</code> error is returned. If a resize operation was initiated and completed, the status of the resize remains as <code>SUCCEEDED</code> until the next resize. <para> A resize operation can be requested using <a>ModifyCluster</a> and specifying a different number or type of nodes for the cluster. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeResize service method.</param> <returns>The response from the DescribeResize service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.ResizeNotFoundException"> A resize operation for the specified cluster is not found. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeResizeAsync(Amazon.Redshift.Model.DescribeResizeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeResize operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeResize operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeSnapshotCopyGrants(Amazon.Redshift.Model.DescribeSnapshotCopyGrantsRequest)"> <summary> Returns a list of snapshot copy grants owned by the AWS account in the destination region. <para> For more information about managing snapshot copy grants, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html">Amazon Redshift Database Encryption</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshotCopyGrants service method.</param> <returns>The response from the DescribeSnapshotCopyGrants service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.SnapshotCopyGrantNotFoundException"> The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeSnapshotCopyGrantsAsync(Amazon.Redshift.Model.DescribeSnapshotCopyGrantsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSnapshotCopyGrants operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshotCopyGrants operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeTags(Amazon.Redshift.Model.DescribeTagsRequest)"> <summary> Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on. <para> The following are limitations for <code>DescribeTags</code>: <ul> <li>You cannot specify an ARN and a resource-type value together in the same request.</li> <li>You cannot use the <code>MaxRecords</code> and <code>Marker</code> parameters together with the ARN parameter.</li> <li>The <code>MaxRecords</code> parameter can be a range from 10 to 50 results to return in a request.</li> </ul> </para> <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all resources that have any combination of those values are returned. </para> <para> If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags service method.</param> <returns>The response from the DescribeTags service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.InvalidTagException"> The tag is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.ResourceNotFoundException"> The resource could not be found. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DescribeTagsAsync(Amazon.Redshift.Model.DescribeTagsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DisableLogging(Amazon.Redshift.Model.DisableLoggingRequest)"> <summary> Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. </summary> <param name="request">Container for the necessary parameters to execute the DisableLogging service method.</param> <returns>The response from the DisableLogging service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DisableLoggingAsync(Amazon.Redshift.Model.DisableLoggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableLogging operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableLogging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DisableSnapshotCopy(Amazon.Redshift.Model.DisableSnapshotCopyRequest)"> <summary> Disables the automatic copying of snapshots from one region to another region for a specified cluster. <para> If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use <a>DeleteSnapshotCopyGrant</a> to delete the grant that grants Amazon Redshift permission to the CMK in the destination region. </para> </summary> <param name="request">Container for the necessary parameters to execute the DisableSnapshotCopy service method.</param> <returns>The response from the DisableSnapshotCopy service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterStateException"> The specified cluster is not in the <code>available</code> state. </exception> <exception cref="T:Amazon.Redshift.Model.SnapshotCopyAlreadyDisabledException"> The cluster already has cross-region snapshot copy disabled. </exception> <exception cref="T:Amazon.Redshift.Model.UnauthorizedOperationException"> Your account is not authorized to perform the requested operation. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.DisableSnapshotCopyAsync(Amazon.Redshift.Model.DisableSnapshotCopyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableSnapshotCopy operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableSnapshotCopy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.EnableLogging(Amazon.Redshift.Model.EnableLoggingRequest)"> <summary> Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. </summary> <param name="request">Container for the necessary parameters to execute the EnableLogging service method.</param> <returns>The response from the EnableLogging service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.BucketNotFoundException"> Could not find the specified S3 bucket. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InsufficientS3BucketPolicyException"> The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling logging. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidS3BucketNameException"> The S3 bucket name is invalid. For more information about naming rules, go to <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html">Bucket Restrictions and Limitations</a> in the Amazon Simple Storage Service (S3) Developer Guide. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidS3KeyPrefixException"> The string specified for the logging S3 key prefix does not comply with the documented constraints. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.EnableLoggingAsync(Amazon.Redshift.Model.EnableLoggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableLogging operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableLogging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.EnableSnapshotCopy(Amazon.Redshift.Model.EnableSnapshotCopyRequest)"> <summary> Enables the automatic copy of snapshots from one region to another region for a specified cluster. </summary> <param name="request">Container for the necessary parameters to execute the EnableSnapshotCopy service method.</param> <returns>The response from the EnableSnapshotCopy service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.CopyToRegionDisabledException"> Cross-region snapshot copy was temporarily disabled. Try your request again. </exception> <exception cref="T:Amazon.Redshift.Model.IncompatibleOrderableOptionsException"> The specified options are incompatible. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterStateException"> The specified cluster is not in the <code>available</code> state. </exception> <exception cref="T:Amazon.Redshift.Model.LimitExceededException"> The encryption key has exceeded its grant limit in AWS KMS. </exception> <exception cref="T:Amazon.Redshift.Model.SnapshotCopyAlreadyEnabledException"> The cluster already has cross-region snapshot copy enabled. </exception> <exception cref="T:Amazon.Redshift.Model.SnapshotCopyGrantNotFoundException"> The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region. </exception> <exception cref="T:Amazon.Redshift.Model.UnauthorizedOperationException"> Your account is not authorized to perform the requested operation. </exception> <exception cref="T:Amazon.Redshift.Model.UnknownSnapshotCopyRegionException"> The specified region is incorrect or does not exist. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.EnableSnapshotCopyAsync(Amazon.Redshift.Model.EnableSnapshotCopyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableSnapshotCopy operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableSnapshotCopy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.ModifyCluster(Amazon.Redshift.Model.ModifyClusterRequest)"> <summary> Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . <para> You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyCluster service method.</param> <returns>The response from the ModifyCluster service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterAlreadyExistsException"> The account already has a cluster with the given identifier. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupNotFoundException"> The cluster security group name does not refer to an existing cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.HsmClientCertificateNotFoundException"> There is no Amazon Redshift HSM client certificate with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.HsmConfigurationNotFoundException"> There is no Amazon Redshift HSM configuration with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InsufficientClusterCapacityException"> The number of nodes specified exceeds the allotted capacity of the cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSecurityGroupStateException"> The state of the cluster security group is not <code>available</code>. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterStateException"> The specified cluster is not in the <code>available</code> state. </exception> <exception cref="T:Amazon.Redshift.Model.LimitExceededException"> The encryption key has exceeded its grant limit in AWS KMS. </exception> <exception cref="T:Amazon.Redshift.Model.NumberOfNodesQuotaExceededException"> The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.UnauthorizedOperationException"> Your account is not authorized to perform the requested operation. </exception> <exception cref="T:Amazon.Redshift.Model.UnsupportedOptionException"> A request option was specified that is not supported. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.ModifyClusterAsync(Amazon.Redshift.Model.ModifyClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.ModifyClusterParameterGroup(Amazon.Redshift.Model.ModifyClusterParameterGroupRequest)"> <summary> Modifies the parameters of a parameter group. <para> For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyClusterParameterGroup service method.</param> <returns>The response from the ModifyClusterParameterGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterParameterGroupStateException"> The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.ModifyClusterParameterGroupAsync(Amazon.Redshift.Model.ModifyClusterParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyClusterParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyClusterParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.ModifyClusterSubnetGroup(Amazon.Redshift.Model.ModifyClusterSubnetGroupRequest)"> <summary> Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets. </summary> <param name="request">Container for the necessary parameters to execute the ModifyClusterSubnetGroup service method.</param> <returns>The response from the ModifyClusterSubnetGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetGroupNotFoundException"> The cluster subnet group name does not refer to an existing cluster subnet group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetQuotaExceededException"> The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidSubnetException"> The requested subnet is not valid, or not all of the subnets are in the same VPC. </exception> <exception cref="T:Amazon.Redshift.Model.SubnetAlreadyInUseException"> A specified subnet is already in use by another cluster. </exception> <exception cref="T:Amazon.Redshift.Model.UnauthorizedOperationException"> Your account is not authorized to perform the requested operation. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.ModifyClusterSubnetGroupAsync(Amazon.Redshift.Model.ModifyClusterSubnetGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyClusterSubnetGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyClusterSubnetGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.ModifyEventSubscription(Amazon.Redshift.Model.ModifyEventSubscriptionRequest)"> <summary> Modifies an existing Amazon Redshift event notification subscription. </summary> <param name="request">Container for the necessary parameters to execute the ModifyEventSubscription service method.</param> <returns>The response from the ModifyEventSubscription service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.InvalidSubscriptionStateException"> The subscription request is invalid because it is a duplicate request. This subscription request is already in progress. </exception> <exception cref="T:Amazon.Redshift.Model.SNSInvalidTopicException"> Amazon SNS has responded that there is a problem with the specified Amazon SNS topic. </exception> <exception cref="T:Amazon.Redshift.Model.SNSNoAuthorizationException"> You do not have permission to publish to the specified Amazon SNS topic. </exception> <exception cref="T:Amazon.Redshift.Model.SNSTopicArnNotFoundException"> An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist. </exception> <exception cref="T:Amazon.Redshift.Model.SourceNotFoundException"> The specified Amazon Redshift event source could not be found. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionCategoryNotFoundException"> The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionEventIdNotFoundException"> An Amazon Redshift event with the specified event ID does not exist. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionNotFoundException"> An Amazon Redshift event notification subscription with the specified name does not exist. </exception> <exception cref="T:Amazon.Redshift.Model.SubscriptionSeverityNotFoundException"> The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.ModifyEventSubscriptionAsync(Amazon.Redshift.Model.ModifyEventSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifyEventSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyEventSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.ModifySnapshotCopyRetentionPeriod(Amazon.Redshift.Model.ModifySnapshotCopyRetentionPeriodRequest)"> <summary> Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region. </summary> <param name="request">Container for the necessary parameters to execute the ModifySnapshotCopyRetentionPeriod service method.</param> <returns>The response from the ModifySnapshotCopyRetentionPeriod service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterStateException"> The specified cluster is not in the <code>available</code> state. </exception> <exception cref="T:Amazon.Redshift.Model.SnapshotCopyDisabledException"> Cross-region snapshot copy was temporarily disabled. Try your request again. </exception> <exception cref="T:Amazon.Redshift.Model.UnauthorizedOperationException"> Your account is not authorized to perform the requested operation. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.ModifySnapshotCopyRetentionPeriodAsync(Amazon.Redshift.Model.ModifySnapshotCopyRetentionPeriodRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ModifySnapshotCopyRetentionPeriod operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifySnapshotCopyRetentionPeriod operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.PurchaseReservedNodeOffering(Amazon.Redshift.Model.PurchaseReservedNodeOfferingRequest)"> <summary> Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the <a>DescribeReservedNodeOfferings</a> API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve. <para> For more information about reserved node offerings, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html">Purchasing Reserved Nodes</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedNodeOffering service method.</param> <returns>The response from the PurchaseReservedNodeOffering service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ReservedNodeAlreadyExistsException"> User already has a reservation with the given identifier. </exception> <exception cref="T:Amazon.Redshift.Model.ReservedNodeOfferingNotFoundException"> Specified offering does not exist. </exception> <exception cref="T:Amazon.Redshift.Model.ReservedNodeQuotaExceededException"> Request would exceed the user's compute node quota. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.UnsupportedOperationException"> The requested operation isn't supported. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.PurchaseReservedNodeOfferingAsync(Amazon.Redshift.Model.PurchaseReservedNodeOfferingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PurchaseReservedNodeOffering operation. </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedNodeOffering operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.RebootCluster(Amazon.Redshift.Model.RebootClusterRequest)"> <summary> Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to <code>rebooting</code>. A cluster event is created when the reboot is completed. Any pending cluster modifications (see <a>ModifyCluster</a>) are applied at this reboot. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> </summary> <param name="request">Container for the necessary parameters to execute the RebootCluster service method.</param> <returns>The response from the RebootCluster service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterStateException"> The specified cluster is not in the <code>available</code> state. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.RebootClusterAsync(Amazon.Redshift.Model.RebootClusterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RebootCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the RebootCluster operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.ResetClusterParameterGroup(Amazon.Redshift.Model.ResetClusterParameterGroupRequest)"> <summary> Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the <i>ResetAllParameters</i> parameter. For parameter changes to take effect you must reboot any associated clusters. </summary> <param name="request">Container for the necessary parameters to execute the ResetClusterParameterGroup service method.</param> <returns>The response from the ResetClusterParameterGroup service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterParameterGroupStateException"> The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.ResetClusterParameterGroupAsync(Amazon.Redshift.Model.ResetClusterParameterGroupRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetClusterParameterGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetClusterParameterGroup operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.RestoreFromClusterSnapshot(Amazon.Redshift.Model.RestoreFromClusterSnapshotRequest)"> <summary> Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the <a>ModifyCluster</a> API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore. <para> If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored. </para> <para> For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RestoreFromClusterSnapshot service method.</param> <returns>The response from the RestoreFromClusterSnapshot service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.AccessToSnapshotDeniedException"> The owner of the specified snapshot has not authorized your account to access the snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterAlreadyExistsException"> The account already has a cluster with the given identifier. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterParameterGroupNotFoundException"> The parameter group name does not refer to an existing parameter group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterQuotaExceededException"> The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupNotFoundException"> The cluster security group name does not refer to an existing cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotNotFoundException"> The snapshot identifier does not refer to an existing cluster snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSubnetGroupNotFoundException"> The cluster subnet group name does not refer to an existing cluster subnet group. </exception> <exception cref="T:Amazon.Redshift.Model.HsmClientCertificateNotFoundException"> There is no Amazon Redshift HSM client certificate with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.HsmConfigurationNotFoundException"> There is no Amazon Redshift HSM configuration with the specified identifier. </exception> <exception cref="T:Amazon.Redshift.Model.InsufficientClusterCapacityException"> The number of nodes specified exceeds the allotted capacity of the cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSnapshotStateException"> The state of the cluster snapshot is not <code>available</code>, or other accounts are authorized to access the snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSubnetGroupStateException"> The cluster subnet group cannot be deleted because it is in use. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidElasticIpException"> The Elastic IP (EIP) is invalid or cannot be found. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidRestoreException"> The restore is invalid. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidSubnetException"> The requested subnet is not valid, or not all of the subnets are in the same VPC. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidVPCNetworkStateException"> The cluster subnet group does not cover all Availability Zones. </exception> <exception cref="T:Amazon.Redshift.Model.LimitExceededException"> The encryption key has exceeded its grant limit in AWS KMS. </exception> <exception cref="T:Amazon.Redshift.Model.NumberOfNodesPerClusterLimitExceededException"> The operation would exceed the number of nodes allowed for a cluster. </exception> <exception cref="T:Amazon.Redshift.Model.NumberOfNodesQuotaExceededException"> The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </exception> <exception cref="T:Amazon.Redshift.Model.UnauthorizedOperationException"> Your account is not authorized to perform the requested operation. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.RestoreFromClusterSnapshotAsync(Amazon.Redshift.Model.RestoreFromClusterSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestoreFromClusterSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreFromClusterSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.RevokeClusterSecurityGroupIngress(Amazon.Redshift.Model.RevokeClusterSecurityGroupIngressRequest)"> <summary> Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see <a>AuthorizeClusterSecurityGroupIngress</a>. For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the RevokeClusterSecurityGroupIngress service method.</param> <returns>The response from the RevokeClusterSecurityGroupIngress service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.AuthorizationNotFoundException"> The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSecurityGroupNotFoundException"> The cluster security group name does not refer to an existing cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterSecurityGroupStateException"> The state of the cluster security group is not <code>available</code>. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.RevokeClusterSecurityGroupIngressAsync(Amazon.Redshift.Model.RevokeClusterSecurityGroupIngressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RevokeClusterSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeClusterSecurityGroupIngress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.RevokeSnapshotAccess(Amazon.Redshift.Model.RevokeSnapshotAccessRequest)"> <summary> Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion. <para> For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RevokeSnapshotAccess service method.</param> <returns>The response from the RevokeSnapshotAccess service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.AccessToSnapshotDeniedException"> The owner of the specified snapshot has not authorized your account to access the snapshot. </exception> <exception cref="T:Amazon.Redshift.Model.AuthorizationNotFoundException"> The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group. </exception> <exception cref="T:Amazon.Redshift.Model.ClusterSnapshotNotFoundException"> The snapshot identifier does not refer to an existing cluster snapshot. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.RevokeSnapshotAccessAsync(Amazon.Redshift.Model.RevokeSnapshotAccessRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RevokeSnapshotAccess operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeSnapshotAccess operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.RotateEncryptionKey(Amazon.Redshift.Model.RotateEncryptionKeyRequest)"> <summary> Rotates the encryption keys for a cluster. </summary> <param name="request">Container for the necessary parameters to execute the RotateEncryptionKey service method.</param> <returns>The response from the RotateEncryptionKey service method, as returned by Redshift.</returns> <exception cref="T:Amazon.Redshift.Model.ClusterNotFoundException"> The <i>ClusterIdentifier</i> parameter does not refer to an existing cluster. </exception> <exception cref="T:Amazon.Redshift.Model.InvalidClusterStateException"> The specified cluster is not in the <code>available</code> state. </exception> </member> <member name="M:Amazon.Redshift.AmazonRedshiftClient.RotateEncryptionKeyAsync(Amazon.Redshift.Model.RotateEncryptionKeyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RotateEncryptionKey operation. </summary> <param name="request">Container for the necessary parameters to execute the RotateEncryptionKey operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.Route53.AmazonRoute53Client"> <summary> Implementation for accessing Route53 </summary> </member> <member name="T:Amazon.Route53.IAmazonRoute53"> <summary> Interface for accessing Route53 </summary> </member> <member name="M:Amazon.Route53.IAmazonRoute53.AssociateVPCWithHostedZone(Amazon.Route53.Model.AssociateVPCWithHostedZoneRequest)"> <summary> 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>/<i>Route 53 API version</i>/hostedzone/<i>hosted zone ID</i>/associatevpc</code> resource. The request body must include a 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> <param name="request">Container for the necessary parameters to execute the AssociateVPCWithHostedZone service method.</param> <returns>The response from the AssociateVPCWithHostedZone service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.ConflictingDomainExistsException"> </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.InvalidVPCIdException"> The hosted zone you are trying to create for your VPC_ID does not belong to you. Amazon Route 53 returns this error when the VPC specified by <code>VPCId</code> does not belong to you. </exception> <exception cref="T:Amazon.Route53.Model.LimitsExceededException"> The limits specified for a resource have been exceeded. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.PublicZoneVPCAssociationException"> The hosted zone you are trying to associate VPC with doesn't have any VPC association. Amazon Route 53 currently doesn't support associate a VPC with a public hosted zone. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.AssociateVPCWithHostedZoneAsync(Amazon.Route53.Model.AssociateVPCWithHostedZoneRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssociateVPCWithHostedZone operation. </summary> <param name="request">Container for the necessary parameters to execute the AssociateVPCWithHostedZone operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ChangeResourceRecordSets(Amazon.Route53.Model.ChangeResourceRecordSetsRequest)"> <summary> Use this action to create or change your authoritative DNS information. To use this action, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/hostedzone/<i>hosted Zone ID</i>/rrset</code> resource. The request body must include a 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/API_ChangeResourceRecordSets.html">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> <param name="request">Container for the necessary parameters to execute the ChangeResourceRecordSets service method.</param> <returns>The response from the ChangeResourceRecordSets service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidChangeBatchException"> This error contains a list of one or more error messages. Each error message indicates one error in the change batch. For more information, see <a href="http://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html#example_Errors">Example InvalidChangeBatch Errors</a>. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.PriorRequestNotCompleteException"> The request was rejected because Amazon Route 53 was still processing a prior request. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ChangeResourceRecordSetsAsync(Amazon.Route53.Model.ChangeResourceRecordSetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ChangeResourceRecordSets operation. </summary> <param name="request">Container for the necessary parameters to execute the ChangeResourceRecordSets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ChangeTagsForResource(Amazon.Route53.Model.ChangeTagsForResourceRequest)"> <summary> </summary> <param name="request">Container for the necessary parameters to execute the ChangeTagsForResource service method.</param> <returns>The response from the ChangeTagsForResource service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.PriorRequestNotCompleteException"> The request was rejected because Amazon Route 53 was still processing a prior request. </exception> <exception cref="T:Amazon.Route53.Model.ThrottlingException"> </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ChangeTagsForResourceAsync(Amazon.Route53.Model.ChangeTagsForResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ChangeTagsForResource operation. </summary> <param name="request">Container for the necessary parameters to execute the ChangeTagsForResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.CreateHealthCheck(Amazon.Route53.Model.CreateHealthCheckRequest)"> <summary> This action creates a new health check. <para> To create a new health check, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/healthcheck</code> resource. The request body must include a document with a <code>CreateHealthCheckRequest</code> element. The response returns the <code>CreateHealthCheckResponse</code> element that contains metadata about the health check. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateHealthCheck service method.</param> <returns>The response from the CreateHealthCheck service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.HealthCheckAlreadyExistsException"> The health check you are trying to create already exists. Amazon Route 53 returns this error when a health check has already been created with the specified <code>CallerReference</code>. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.TooManyHealthChecksException"> </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.CreateHealthCheckAsync(Amazon.Route53.Model.CreateHealthCheckRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateHealthCheck operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateHealthCheck operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.CreateHostedZone(Amazon.Route53.Model.CreateHostedZoneRequest)"> <summary> This action creates a new hosted zone. <para> To create a new hosted zone, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/hostedzone</code> resource. The request body must include a 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> <param name="request">Container for the necessary parameters to execute the CreateHostedZone service method.</param> <returns>The response from the CreateHostedZone service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.ConflictingDomainExistsException"> </exception> <exception cref="T:Amazon.Route53.Model.DelegationSetNotAvailableException"> Amazon Route 53 allows some duplicate domain names, but there is a maximum number of duplicate names. This error indicates that you have reached that maximum. If you want to create another hosted zone with the same name and Amazon Route 53 generates this error, you can request an increase to the limit on the <a href="http://aws.amazon.com/route53-request/">Contact Us</a> page. </exception> <exception cref="T:Amazon.Route53.Model.DelegationSetNotReusableException"> The specified delegation set has not been marked as reusable. </exception> <exception cref="T:Amazon.Route53.Model.HostedZoneAlreadyExistsException"> The hosted zone you are trying to create already exists. Amazon Route 53 returns this error when a hosted zone has already been created with the specified <code>CallerReference</code>. </exception> <exception cref="T:Amazon.Route53.Model.InvalidDomainNameException"> This error indicates that the specified domain name is not valid. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.InvalidVPCIdException"> The hosted zone you are trying to create for your VPC_ID does not belong to you. Amazon Route 53 returns this error when the VPC specified by <code>VPCId</code> does not belong to you. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchDelegationSetException"> The specified delegation set does not exist. </exception> <exception cref="T:Amazon.Route53.Model.TooManyHostedZonesException"> This error indicates that you've reached the maximum number of hosted zones that can be created for the current AWS account. You can request an increase to the limit on the <a href="http://aws.amazon.com/route53-request/">Contact Us</a> page. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.CreateHostedZoneAsync(Amazon.Route53.Model.CreateHostedZoneRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateHostedZone operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateHostedZone operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.CreateReusableDelegationSet(Amazon.Route53.Model.CreateReusableDelegationSetRequest)"> <summary> This action creates a reusable delegationSet. <para> To create a new reusable delegationSet, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/delegationset</code> resource. The request body must include a 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> <param name="request">Container for the necessary parameters to execute the CreateReusableDelegationSet service method.</param> <returns>The response from the CreateReusableDelegationSet service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.DelegationSetAlreadyCreatedException"> A delegation set with the same owner and caller reference combination has already been created. </exception> <exception cref="T:Amazon.Route53.Model.DelegationSetAlreadyReusableException"> The specified delegation set has already been marked as reusable. </exception> <exception cref="T:Amazon.Route53.Model.DelegationSetNotAvailableException"> Amazon Route 53 allows some duplicate domain names, but there is a maximum number of duplicate names. This error indicates that you have reached that maximum. If you want to create another hosted zone with the same name and Amazon Route 53 generates this error, you can request an increase to the limit on the <a href="http://aws.amazon.com/route53-request/">Contact Us</a> page. </exception> <exception cref="T:Amazon.Route53.Model.HostedZoneNotFoundException"> The specified HostedZone cannot be found. </exception> <exception cref="T:Amazon.Route53.Model.InvalidArgumentException"> At least one of the specified arguments is invalid. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.LimitsExceededException"> The limits specified for a resource have been exceeded. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.CreateReusableDelegationSetAsync(Amazon.Route53.Model.CreateReusableDelegationSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateReusableDelegationSet operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateReusableDelegationSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.CreateTrafficPolicy(Amazon.Route53.Model.CreateTrafficPolicyRequest)"> <summary> 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>/<i>Route 53 API version</i>/trafficpolicy</code> resource. The request body must include a 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> <param name="request">Container for the necessary parameters to execute the CreateTrafficPolicy service method.</param> <returns>The response from the CreateTrafficPolicy service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.InvalidTrafficPolicyDocumentException"> The format of the traffic policy document that you specified in the <code>Document</code> element is invalid. </exception> <exception cref="T:Amazon.Route53.Model.TooManyTrafficPoliciesException"> You've created the maximum number of traffic policies that can be created for the current AWS account. You can request an increase to the limit on the <a href="http://aws.amazon.com/route53-request/">Contact Us</a> page. </exception> <exception cref="T:Amazon.Route53.Model.TrafficPolicyAlreadyExistsException"> A traffic policy that has the same value for <code>Name</code> already exists. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.CreateTrafficPolicyAsync(Amazon.Route53.Model.CreateTrafficPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTrafficPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrafficPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.CreateTrafficPolicyInstance(Amazon.Route53.Model.CreateTrafficPolicyInstanceRequest)"> <summary> 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>/<i>Route 53 API version</i>/trafficpolicyinstance</code> resource. The request body must include a 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> <param name="request">Container for the necessary parameters to execute the CreateTrafficPolicyInstance service method.</param> <returns>The response from the CreateTrafficPolicyInstance service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyException"> No traffic policy exists with the specified ID. </exception> <exception cref="T:Amazon.Route53.Model.TooManyTrafficPolicyInstancesException"> You've created the maximum number of traffic policy instances that can be created for the current AWS account. You can request an increase to the limit on the <a href="http://aws.amazon.com/route53-request/">Contact Us</a> page. </exception> <exception cref="T:Amazon.Route53.Model.TrafficPolicyInstanceAlreadyExistsException"> Traffic policy instance with given Id already exists. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.CreateTrafficPolicyInstanceAsync(Amazon.Route53.Model.CreateTrafficPolicyInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTrafficPolicyInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrafficPolicyInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.CreateTrafficPolicyVersion(Amazon.Route53.Model.CreateTrafficPolicyVersionRequest)"> <summary> 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>/<i>Route 53 API version</i>/trafficpolicy/</code> resource. The request body includes a 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> <param name="request">Container for the necessary parameters to execute the CreateTrafficPolicyVersion service method.</param> <returns>The response from the CreateTrafficPolicyVersion service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.ConcurrentModificationException"> Another user submitted a request to update the object at the same time that you did. Retry the request. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.InvalidTrafficPolicyDocumentException"> The format of the traffic policy document that you specified in the <code>Document</code> element is invalid. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyException"> No traffic policy exists with the specified ID. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.CreateTrafficPolicyVersionAsync(Amazon.Route53.Model.CreateTrafficPolicyVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTrafficPolicyVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrafficPolicyVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.DeleteHealthCheck(Amazon.Route53.Model.DeleteHealthCheckRequest)"> <summary> This action deletes a health check. To delete a health check, send a <code>DELETE</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the DeleteHealthCheck service method.</param> <returns>The response from the DeleteHealthCheck service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.HealthCheckInUseException"> There are resource records associated with this health check. Before you can delete the health check, you must disassociate it from the resource record sets. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.DeleteHealthCheckAsync(Amazon.Route53.Model.DeleteHealthCheckRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteHealthCheck operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHealthCheck operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.DeleteHostedZone(Amazon.Route53.Model.DeleteHostedZoneRequest)"> <summary> This action deletes a hosted zone. To delete a hosted zone, send a <code>DELETE</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the DeleteHostedZone service method.</param> <returns>The response from the DeleteHostedZone service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.HostedZoneNotEmptyException"> The hosted zone contains resource record sets in addition to the default NS and SOA resource record sets. Before you can delete the hosted zone, you must delete the additional resource record sets. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.PriorRequestNotCompleteException"> The request was rejected because Amazon Route 53 was still processing a prior request. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.DeleteHostedZoneAsync(Amazon.Route53.Model.DeleteHostedZoneRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteHostedZone operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHostedZone operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.DeleteReusableDelegationSet(Amazon.Route53.Model.DeleteReusableDelegationSetRequest)"> <summary> This action deletes a reusable delegation set. To delete a reusable delegation set, send a <code>DELETE</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the DeleteReusableDelegationSet service method.</param> <returns>The response from the DeleteReusableDelegationSet service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.DelegationSetInUseException"> The specified delegation contains associated hosted zones which must be deleted before the reusable delegation set can be deleted. </exception> <exception cref="T:Amazon.Route53.Model.DelegationSetNotReusableException"> The specified delegation set has not been marked as reusable. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchDelegationSetException"> The specified delegation set does not exist. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.DeleteReusableDelegationSetAsync(Amazon.Route53.Model.DeleteReusableDelegationSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteReusableDelegationSet operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteReusableDelegationSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.DeleteTrafficPolicy(Amazon.Route53.Model.DeleteTrafficPolicyRequest)"> <summary> Deletes a traffic policy. To delete a traffic policy, send a <code>DELETE</code> request to the <code>/<i>Route 53 API version</i>/trafficpolicy</code> resource. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrafficPolicy service method.</param> <returns>The response from the DeleteTrafficPolicy service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.ConcurrentModificationException"> Another user submitted a request to update the object at the same time that you did. Retry the request. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyException"> No traffic policy exists with the specified ID. </exception> <exception cref="T:Amazon.Route53.Model.TrafficPolicyInUseException"> One or more traffic policy instances were created by using the specified traffic policy. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.DeleteTrafficPolicyAsync(Amazon.Route53.Model.DeleteTrafficPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTrafficPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrafficPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.DeleteTrafficPolicyInstance(Amazon.Route53.Model.DeleteTrafficPolicyInstanceRequest)"> <summary> 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>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the DeleteTrafficPolicyInstance service method.</param> <returns>The response from the DeleteTrafficPolicyInstance service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyInstanceException"> No traffic policy instance exists with the specified ID. </exception> <exception cref="T:Amazon.Route53.Model.PriorRequestNotCompleteException"> The request was rejected because Amazon Route 53 was still processing a prior request. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.DeleteTrafficPolicyInstanceAsync(Amazon.Route53.Model.DeleteTrafficPolicyInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTrafficPolicyInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrafficPolicyInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.DisassociateVPCFromHostedZone(Amazon.Route53.Model.DisassociateVPCFromHostedZoneRequest)"> <summary> 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>/<i>Route 53 API version</i>/hostedzone/<i>hosted zone ID</i>/disassociatevpc</code> resource. The request body must include a 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> <param name="request">Container for the necessary parameters to execute the DisassociateVPCFromHostedZone service method.</param> <returns>The response from the DisassociateVPCFromHostedZone service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.InvalidVPCIdException"> The hosted zone you are trying to create for your VPC_ID does not belong to you. Amazon Route 53 returns this error when the VPC specified by <code>VPCId</code> does not belong to you. </exception> <exception cref="T:Amazon.Route53.Model.LastVPCAssociationException"> The VPC you are trying to disassociate from the hosted zone is the last the VPC that is associated with the hosted zone. Amazon Route 53 currently doesn't support disassociate the last VPC from the hosted zone. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.VPCAssociationNotFoundException"> The VPC you specified is not currently associated with the hosted zone. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.DisassociateVPCFromHostedZoneAsync(Amazon.Route53.Model.DisassociateVPCFromHostedZoneRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisassociateVPCFromHostedZone operation. </summary> <param name="request">Container for the necessary parameters to execute the DisassociateVPCFromHostedZone operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetChange(Amazon.Route53.Model.GetChangeRequest)"> <summary> 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> <param name="request">Container for the necessary parameters to execute the GetChange service method.</param> <returns>The response from the GetChange service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchChangeException"> </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetChangeAsync(Amazon.Route53.Model.GetChangeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetChange operation. </summary> <param name="request">Container for the necessary parameters to execute the GetChange operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetChangeDetails(Amazon.Route53.Model.GetChangeDetailsRequest)"> <summary> This action returns the status and changes of a change batch request. </summary> <param name="request">Container for the necessary parameters to execute the GetChangeDetails service method.</param> <returns>The response from the GetChangeDetails service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchChangeException"> </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetChangeDetailsAsync(Amazon.Route53.Model.GetChangeDetailsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetChangeDetails operation. </summary> <param name="request">Container for the necessary parameters to execute the GetChangeDetails operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetCheckerIpRanges(Amazon.Route53.Model.GetCheckerIpRangesRequest)"> <summary> 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>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the GetCheckerIpRanges service method.</param> <returns>The response from the GetCheckerIpRanges service method, as returned by Route53.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetCheckerIpRangesAsync(Amazon.Route53.Model.GetCheckerIpRangesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetCheckerIpRanges operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCheckerIpRanges operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetGeoLocation(Amazon.Route53.Model.GetGeoLocationRequest)"> <summary> To retrieve a single geo location, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/geolocation</code> resource with one of these options: continentcode | countrycode | countrycode and subdivisioncode. </summary> <param name="request">Container for the necessary parameters to execute the GetGeoLocation service method.</param> <returns>The response from the GetGeoLocation service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchGeoLocationException"> The geo location you are trying to get does not exist. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetGeoLocationAsync(Amazon.Route53.Model.GetGeoLocationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetGeoLocation operation. </summary> <param name="request">Container for the necessary parameters to execute the GetGeoLocation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetHealthCheck(Amazon.Route53.Model.GetHealthCheckRequest)"> <summary> To retrieve the health check, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/healthcheck/<i>health check ID</i></code> resource. </summary> <param name="request">Container for the necessary parameters to execute the GetHealthCheck service method.</param> <returns>The response from the GetHealthCheck service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.IncompatibleVersionException"> The resource you are trying to access is unsupported on this Amazon Route 53 endpoint. Please consider using a newer endpoint or a tool that does so. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetHealthCheckAsync(Amazon.Route53.Model.GetHealthCheckRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetHealthCheck operation. </summary> <param name="request">Container for the necessary parameters to execute the GetHealthCheck operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetHealthCheckCount(Amazon.Route53.Model.GetHealthCheckCountRequest)"> <summary> To retrieve a count of all your health checks, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/healthcheckcount</code> resource. </summary> <param name="request">Container for the necessary parameters to execute the GetHealthCheckCount service method.</param> <returns>The response from the GetHealthCheckCount service method, as returned by Route53.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetHealthCheckCountAsync(Amazon.Route53.Model.GetHealthCheckCountRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetHealthCheckCount operation. </summary> <param name="request">Container for the necessary parameters to execute the GetHealthCheckCount operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetHealthCheckLastFailureReason(Amazon.Route53.Model.GetHealthCheckLastFailureReasonRequest)"> <summary> 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>/<i>Route 53 API version</i>/healthcheck/<i>health check ID</i>/lastfailurereason</code> resource. </summary> <param name="request">Container for the necessary parameters to execute the GetHealthCheckLastFailureReason service method.</param> <returns>The response from the GetHealthCheckLastFailureReason service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetHealthCheckLastFailureReasonAsync(Amazon.Route53.Model.GetHealthCheckLastFailureReasonRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetHealthCheckLastFailureReason operation. </summary> <param name="request">Container for the necessary parameters to execute the GetHealthCheckLastFailureReason operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetHealthCheckStatus(Amazon.Route53.Model.GetHealthCheckStatusRequest)"> <summary> To retrieve the health check status, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/healthcheck/<i>health check ID</i>/status</code> resource. You can use this call to get a health check's current status. </summary> <param name="request">Container for the necessary parameters to execute the GetHealthCheckStatus service method.</param> <returns>The response from the GetHealthCheckStatus service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetHealthCheckStatusAsync(Amazon.Route53.Model.GetHealthCheckStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetHealthCheckStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the GetHealthCheckStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetHostedZone(Amazon.Route53.Model.GetHostedZoneRequest)"> <summary> To retrieve the delegation set for a hosted zone, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the GetHostedZone service method.</param> <returns>The response from the GetHostedZone service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetHostedZoneAsync(Amazon.Route53.Model.GetHostedZoneRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetHostedZone operation. </summary> <param name="request">Container for the necessary parameters to execute the GetHostedZone operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetHostedZoneCount"> <summary> To retrieve a count of all your hosted zones, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/hostedzonecount</code> resource. </summary> <returns>The response from the GetHostedZoneCount service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetHostedZoneCount(Amazon.Route53.Model.GetHostedZoneCountRequest)"> <summary> To retrieve a count of all your hosted zones, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/hostedzonecount</code> resource. </summary> <param name="request">Container for the necessary parameters to execute the GetHostedZoneCount service method.</param> <returns>The response from the GetHostedZoneCount service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetHostedZoneCountAsync(Amazon.Route53.Model.GetHostedZoneCountRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetHostedZoneCount operation. </summary> <param name="request">Container for the necessary parameters to execute the GetHostedZoneCount operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetReusableDelegationSet(Amazon.Route53.Model.GetReusableDelegationSetRequest)"> <summary> To retrieve the reusable delegation set, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/delegationset/<i>delegation set ID</i></code> resource. </summary> <param name="request">Container for the necessary parameters to execute the GetReusableDelegationSet service method.</param> <returns>The response from the GetReusableDelegationSet service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.DelegationSetNotReusableException"> The specified delegation set has not been marked as reusable. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchDelegationSetException"> The specified delegation set does not exist. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetReusableDelegationSetAsync(Amazon.Route53.Model.GetReusableDelegationSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetReusableDelegationSet operation. </summary> <param name="request">Container for the necessary parameters to execute the GetReusableDelegationSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetTrafficPolicy(Amazon.Route53.Model.GetTrafficPolicyRequest)"> <summary> Gets information about a specific traffic policy version. To get the information, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/trafficpolicy</code> resource. </summary> <param name="request">Container for the necessary parameters to execute the GetTrafficPolicy service method.</param> <returns>The response from the GetTrafficPolicy service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyException"> No traffic policy exists with the specified ID. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetTrafficPolicyAsync(Amazon.Route53.Model.GetTrafficPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetTrafficPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTrafficPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetTrafficPolicyInstance(Amazon.Route53.Model.GetTrafficPolicyInstanceRequest)"> <summary> 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>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the GetTrafficPolicyInstance service method.</param> <returns>The response from the GetTrafficPolicyInstance service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyInstanceException"> No traffic policy instance exists with the specified ID. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetTrafficPolicyInstanceAsync(Amazon.Route53.Model.GetTrafficPolicyInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetTrafficPolicyInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTrafficPolicyInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetTrafficPolicyInstanceCount(Amazon.Route53.Model.GetTrafficPolicyInstanceCountRequest)"> <summary> 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>/<i>Route 53 API version</i>/trafficpolicyinstancecount</code> resource. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetTrafficPolicyInstanceCount service method.</param> <returns>The response from the GetTrafficPolicyInstanceCount service method, as returned by Route53.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.GetTrafficPolicyInstanceCountAsync(Amazon.Route53.Model.GetTrafficPolicyInstanceCountRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetTrafficPolicyInstanceCount operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTrafficPolicyInstanceCount operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListChangeBatchesByHostedZone(Amazon.Route53.Model.ListChangeBatchesByHostedZoneRequest)"> <summary> This action gets the list of ChangeBatches in a given time period for a given hosted zone. </summary> <param name="request">Container for the necessary parameters to execute the ListChangeBatchesByHostedZone service method.</param> <returns>The response from the ListChangeBatchesByHostedZone service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListChangeBatchesByHostedZoneAsync(Amazon.Route53.Model.ListChangeBatchesByHostedZoneRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListChangeBatchesByHostedZone operation. </summary> <param name="request">Container for the necessary parameters to execute the ListChangeBatchesByHostedZone operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListChangeBatchesByRRSet(Amazon.Route53.Model.ListChangeBatchesByRRSetRequest)"> <summary> This action gets the list of ChangeBatches in a given time period for a given hosted zone and RRSet. </summary> <param name="request">Container for the necessary parameters to execute the ListChangeBatchesByRRSet service method.</param> <returns>The response from the ListChangeBatchesByRRSet service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListChangeBatchesByRRSetAsync(Amazon.Route53.Model.ListChangeBatchesByRRSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListChangeBatchesByRRSet operation. </summary> <param name="request">Container for the necessary parameters to execute the ListChangeBatchesByRRSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListGeoLocations"> <summary> To retrieve a list of supported geo locations, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <returns>The response from the ListGeoLocations service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListGeoLocations(Amazon.Route53.Model.ListGeoLocationsRequest)"> <summary> To retrieve a list of supported geo locations, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListGeoLocations service method.</param> <returns>The response from the ListGeoLocations service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListGeoLocationsAsync(Amazon.Route53.Model.ListGeoLocationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListGeoLocations operation. </summary> <param name="request">Container for the necessary parameters to execute the ListGeoLocations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListHealthChecks"> <summary> To retrieve a list of your health checks, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <returns>The response from the ListHealthChecks service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.IncompatibleVersionException"> The resource you are trying to access is unsupported on this Amazon Route 53 endpoint. Please consider using a newer endpoint or a tool that does so. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListHealthChecks(Amazon.Route53.Model.ListHealthChecksRequest)"> <summary> To retrieve a list of your health checks, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListHealthChecks service method.</param> <returns>The response from the ListHealthChecks service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.IncompatibleVersionException"> The resource you are trying to access is unsupported on this Amazon Route 53 endpoint. Please consider using a newer endpoint or a tool that does so. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListHealthChecksAsync(Amazon.Route53.Model.ListHealthChecksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListHealthChecks operation. </summary> <param name="request">Container for the necessary parameters to execute the ListHealthChecks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListHostedZones"> <summary> To retrieve a list of your hosted zones, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <returns>The response from the ListHostedZones service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.DelegationSetNotReusableException"> The specified delegation set has not been marked as reusable. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchDelegationSetException"> The specified delegation set does not exist. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListHostedZones(Amazon.Route53.Model.ListHostedZonesRequest)"> <summary> To retrieve a list of your hosted zones, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListHostedZones service method.</param> <returns>The response from the ListHostedZones service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.DelegationSetNotReusableException"> The specified delegation set has not been marked as reusable. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchDelegationSetException"> The specified delegation set does not exist. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListHostedZonesAsync(Amazon.Route53.Model.ListHostedZonesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListHostedZones operation. </summary> <param name="request">Container for the necessary parameters to execute the ListHostedZones operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListHostedZonesByName(Amazon.Route53.Model.ListHostedZonesByNameRequest)"> <summary> To retrieve a list of your hosted zones in lexicographic order, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListHostedZonesByName service method.</param> <returns>The response from the ListHostedZonesByName service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidDomainNameException"> This error indicates that the specified domain name is not valid. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListHostedZonesByNameAsync(Amazon.Route53.Model.ListHostedZonesByNameRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListHostedZonesByName operation. </summary> <param name="request">Container for the necessary parameters to execute the ListHostedZonesByName operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListResourceRecordSets(Amazon.Route53.Model.ListResourceRecordSetsRequest)"> <summary> 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> <param name="request">Container for the necessary parameters to execute the ListResourceRecordSets service method.</param> <returns>The response from the ListResourceRecordSets service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListResourceRecordSetsAsync(Amazon.Route53.Model.ListResourceRecordSetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListResourceRecordSets operation. </summary> <param name="request">Container for the necessary parameters to execute the ListResourceRecordSets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListReusableDelegationSets"> <summary> To retrieve a list of your reusable delegation sets, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <returns>The response from the ListReusableDelegationSets service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListReusableDelegationSets(Amazon.Route53.Model.ListReusableDelegationSetsRequest)"> <summary> To retrieve a list of your reusable delegation sets, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListReusableDelegationSets service method.</param> <returns>The response from the ListReusableDelegationSets service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListReusableDelegationSetsAsync(Amazon.Route53.Model.ListReusableDelegationSetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListReusableDelegationSets operation. </summary> <param name="request">Container for the necessary parameters to execute the ListReusableDelegationSets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListTagsForResource(Amazon.Route53.Model.ListTagsForResourceRequest)"> <summary> </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResource service method.</param> <returns>The response from the ListTagsForResource service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.PriorRequestNotCompleteException"> The request was rejected because Amazon Route 53 was still processing a prior request. </exception> <exception cref="T:Amazon.Route53.Model.ThrottlingException"> </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListTagsForResourceAsync(Amazon.Route53.Model.ListTagsForResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTagsForResource operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListTagsForResources(Amazon.Route53.Model.ListTagsForResourcesRequest)"> <summary> </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResources service method.</param> <returns>The response from the ListTagsForResources service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.PriorRequestNotCompleteException"> The request was rejected because Amazon Route 53 was still processing a prior request. </exception> <exception cref="T:Amazon.Route53.Model.ThrottlingException"> </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListTagsForResourcesAsync(Amazon.Route53.Model.ListTagsForResourcesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTagsForResources operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResources operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListTrafficPolicies(Amazon.Route53.Model.ListTrafficPoliciesRequest)"> <summary> 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>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicies service method.</param> <returns>The response from the ListTrafficPolicies service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListTrafficPoliciesAsync(Amazon.Route53.Model.ListTrafficPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTrafficPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListTrafficPolicyInstances(Amazon.Route53.Model.ListTrafficPolicyInstancesRequest)"> <summary> 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>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicyInstances service method.</param> <returns>The response from the ListTrafficPolicyInstances service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyInstanceException"> No traffic policy instance exists with the specified ID. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListTrafficPolicyInstancesAsync(Amazon.Route53.Model.ListTrafficPolicyInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTrafficPolicyInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicyInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListTrafficPolicyInstancesByHostedZone(Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneRequest)"> <summary> 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>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicyInstancesByHostedZone service method.</param> <returns>The response from the ListTrafficPolicyInstancesByHostedZone service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyInstanceException"> No traffic policy instance exists with the specified ID. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListTrafficPolicyInstancesByHostedZoneAsync(Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTrafficPolicyInstancesByHostedZone operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicyInstancesByHostedZone operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListTrafficPolicyInstancesByPolicy(Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyRequest)"> <summary> 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>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicyInstancesByPolicy service method.</param> <returns>The response from the ListTrafficPolicyInstancesByPolicy service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyException"> No traffic policy exists with the specified ID. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyInstanceException"> No traffic policy instance exists with the specified ID. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListTrafficPolicyInstancesByPolicyAsync(Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTrafficPolicyInstancesByPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicyInstancesByPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListTrafficPolicyVersions(Amazon.Route53.Model.ListTrafficPolicyVersionsRequest)"> <summary> 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> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicyVersions service method.</param> <returns>The response from the ListTrafficPolicyVersions service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyException"> No traffic policy exists with the specified ID. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.ListTrafficPolicyVersionsAsync(Amazon.Route53.Model.ListTrafficPolicyVersionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTrafficPolicyVersions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicyVersions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.UpdateHealthCheck(Amazon.Route53.Model.UpdateHealthCheckRequest)"> <summary> This action updates an existing health check. <para> To update a health check, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/healthcheck/<i>health check ID</i></code> resource. The request body must include a document with an <code>UpdateHealthCheckRequest</code> element. The response returns an <code>UpdateHealthCheckResponse</code> element, which contains metadata about the health check. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateHealthCheck service method.</param> <returns>The response from the UpdateHealthCheck service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.HealthCheckVersionMismatchException"> </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.UpdateHealthCheckAsync(Amazon.Route53.Model.UpdateHealthCheckRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateHealthCheck operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateHealthCheck operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.UpdateHostedZoneComment(Amazon.Route53.Model.UpdateHostedZoneCommentRequest)"> <summary> To update the hosted zone comment, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/hostedzone/<i>hosted zone ID</i></code> resource. The request body must include a document with a <code>UpdateHostedZoneCommentRequest</code> element. The response to this request includes the modified <code>HostedZone</code> element. <note> The comment can have a maximum length of 256 characters.</note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateHostedZoneComment service method.</param> <returns>The response from the UpdateHostedZoneComment service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.UpdateHostedZoneCommentAsync(Amazon.Route53.Model.UpdateHostedZoneCommentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateHostedZoneComment operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateHostedZoneComment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.UpdateTrafficPolicyComment(Amazon.Route53.Model.UpdateTrafficPolicyCommentRequest)"> <summary> Updates the comment for a specified traffic policy version. <para> To update the comment, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/trafficpolicy/</code> resource. </para> <para> The request body must include a document with an <code>UpdateTrafficPolicyCommentRequest</code> element. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateTrafficPolicyComment service method.</param> <returns>The response from the UpdateTrafficPolicyComment service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.ConcurrentModificationException"> Another user submitted a request to update the object at the same time that you did. Retry the request. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyException"> No traffic policy exists with the specified ID. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.UpdateTrafficPolicyCommentAsync(Amazon.Route53.Model.UpdateTrafficPolicyCommentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateTrafficPolicyComment operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTrafficPolicyComment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.IAmazonRoute53.UpdateTrafficPolicyInstance(Amazon.Route53.Model.UpdateTrafficPolicyInstanceRequest)"> <summary> Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version. <important>The DNS type of the resource record sets that you're updating must match the DNS type in the JSON document that is associated with the traffic policy version that you're using to update the traffic policy instance.</important> <para> When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Amazon Route 53 performs the following operations: </para> <ol> <li>Amazon Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how substantial the differences are between the existing resource record sets and the new resource record sets. </li> <li>When all of the new resource record sets have been created, Amazon Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.</li> <li>Amazon Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.</li> </ol> <para> To update a traffic policy instance, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/trafficpolicyinstance/<i>traffic policy ID</i></code> resource. The request body must include a document with an <code>UpdateTrafficPolicyInstanceRequest</code> element. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateTrafficPolicyInstance service method.</param> <returns>The response from the UpdateTrafficPolicyInstance service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.ConflictingTypesException"> You tried to update a traffic policy instance by using a traffic policy version that has a different DNS type than the current type for the instance. You specified the type in the JSON document in the <code>CreateTrafficPolicy</code> or <code>CreateTrafficPolicyVersion</code>request. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyException"> No traffic policy exists with the specified ID. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyInstanceException"> No traffic policy instance exists with the specified ID. </exception> <exception cref="T:Amazon.Route53.Model.PriorRequestNotCompleteException"> The request was rejected because Amazon Route 53 was still processing a prior request. </exception> </member> <member name="M:Amazon.Route53.IAmazonRoute53.UpdateTrafficPolicyInstanceAsync(Amazon.Route53.Model.UpdateTrafficPolicyInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateTrafficPolicyInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTrafficPolicyInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.#ctor"> <summary> Constructs AmazonRoute53Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonRoute53Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.#ctor(Amazon.Route53.AmazonRoute53Config)"> <summary> Constructs AmazonRoute53Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonRoute53Client Configuration Object</param> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonRoute53Client with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonRoute53Client with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.#ctor(Amazon.Runtime.AWSCredentials,Amazon.Route53.AmazonRoute53Config)"> <summary> Constructs AmazonRoute53Client with AWS Credentials and an AmazonRoute53Client Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonRoute53Client Configuration Object</param> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.#ctor(System.String,System.String)"> <summary> Constructs AmazonRoute53Client with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonRoute53Client with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.#ctor(System.String,System.String,Amazon.Route53.AmazonRoute53Config)"> <summary> Constructs AmazonRoute53Client with AWS Access Key ID, AWS Secret Key and an AmazonRoute53Client Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonRoute53Client Configuration Object</param> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonRoute53Client with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonRoute53Client with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.#ctor(System.String,System.String,System.String,Amazon.Route53.AmazonRoute53Config)"> <summary> Constructs AmazonRoute53Client with AWS Access Key ID, AWS Secret Key and an AmazonRoute53Client Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonRoute53Client Configuration Object</param> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.AssociateVPCWithHostedZone(Amazon.Route53.Model.AssociateVPCWithHostedZoneRequest)"> <summary> 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>/<i>Route 53 API version</i>/hostedzone/<i>hosted zone ID</i>/associatevpc</code> resource. The request body must include a 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> <param name="request">Container for the necessary parameters to execute the AssociateVPCWithHostedZone service method.</param> <returns>The response from the AssociateVPCWithHostedZone service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.ConflictingDomainExistsException"> </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.InvalidVPCIdException"> The hosted zone you are trying to create for your VPC_ID does not belong to you. Amazon Route 53 returns this error when the VPC specified by <code>VPCId</code> does not belong to you. </exception> <exception cref="T:Amazon.Route53.Model.LimitsExceededException"> The limits specified for a resource have been exceeded. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.PublicZoneVPCAssociationException"> The hosted zone you are trying to associate VPC with doesn't have any VPC association. Amazon Route 53 currently doesn't support associate a VPC with a public hosted zone. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.AssociateVPCWithHostedZoneAsync(Amazon.Route53.Model.AssociateVPCWithHostedZoneRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssociateVPCWithHostedZone operation. </summary> <param name="request">Container for the necessary parameters to execute the AssociateVPCWithHostedZone operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ChangeResourceRecordSets(Amazon.Route53.Model.ChangeResourceRecordSetsRequest)"> <summary> Use this action to create or change your authoritative DNS information. To use this action, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/hostedzone/<i>hosted Zone ID</i>/rrset</code> resource. The request body must include a 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/API_ChangeResourceRecordSets.html">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> <param name="request">Container for the necessary parameters to execute the ChangeResourceRecordSets service method.</param> <returns>The response from the ChangeResourceRecordSets service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidChangeBatchException"> This error contains a list of one or more error messages. Each error message indicates one error in the change batch. For more information, see <a href="http://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html#example_Errors">Example InvalidChangeBatch Errors</a>. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.PriorRequestNotCompleteException"> The request was rejected because Amazon Route 53 was still processing a prior request. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ChangeResourceRecordSetsAsync(Amazon.Route53.Model.ChangeResourceRecordSetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ChangeResourceRecordSets operation. </summary> <param name="request">Container for the necessary parameters to execute the ChangeResourceRecordSets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ChangeTagsForResource(Amazon.Route53.Model.ChangeTagsForResourceRequest)"> <summary> </summary> <param name="request">Container for the necessary parameters to execute the ChangeTagsForResource service method.</param> <returns>The response from the ChangeTagsForResource service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.PriorRequestNotCompleteException"> The request was rejected because Amazon Route 53 was still processing a prior request. </exception> <exception cref="T:Amazon.Route53.Model.ThrottlingException"> </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ChangeTagsForResourceAsync(Amazon.Route53.Model.ChangeTagsForResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ChangeTagsForResource operation. </summary> <param name="request">Container for the necessary parameters to execute the ChangeTagsForResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.CreateHealthCheck(Amazon.Route53.Model.CreateHealthCheckRequest)"> <summary> This action creates a new health check. <para> To create a new health check, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/healthcheck</code> resource. The request body must include a document with a <code>CreateHealthCheckRequest</code> element. The response returns the <code>CreateHealthCheckResponse</code> element that contains metadata about the health check. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateHealthCheck service method.</param> <returns>The response from the CreateHealthCheck service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.HealthCheckAlreadyExistsException"> The health check you are trying to create already exists. Amazon Route 53 returns this error when a health check has already been created with the specified <code>CallerReference</code>. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.TooManyHealthChecksException"> </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.CreateHealthCheckAsync(Amazon.Route53.Model.CreateHealthCheckRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateHealthCheck operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateHealthCheck operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.CreateHostedZone(Amazon.Route53.Model.CreateHostedZoneRequest)"> <summary> This action creates a new hosted zone. <para> To create a new hosted zone, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/hostedzone</code> resource. The request body must include a 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> <param name="request">Container for the necessary parameters to execute the CreateHostedZone service method.</param> <returns>The response from the CreateHostedZone service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.ConflictingDomainExistsException"> </exception> <exception cref="T:Amazon.Route53.Model.DelegationSetNotAvailableException"> Amazon Route 53 allows some duplicate domain names, but there is a maximum number of duplicate names. This error indicates that you have reached that maximum. If you want to create another hosted zone with the same name and Amazon Route 53 generates this error, you can request an increase to the limit on the <a href="http://aws.amazon.com/route53-request/">Contact Us</a> page. </exception> <exception cref="T:Amazon.Route53.Model.DelegationSetNotReusableException"> The specified delegation set has not been marked as reusable. </exception> <exception cref="T:Amazon.Route53.Model.HostedZoneAlreadyExistsException"> The hosted zone you are trying to create already exists. Amazon Route 53 returns this error when a hosted zone has already been created with the specified <code>CallerReference</code>. </exception> <exception cref="T:Amazon.Route53.Model.InvalidDomainNameException"> This error indicates that the specified domain name is not valid. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.InvalidVPCIdException"> The hosted zone you are trying to create for your VPC_ID does not belong to you. Amazon Route 53 returns this error when the VPC specified by <code>VPCId</code> does not belong to you. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchDelegationSetException"> The specified delegation set does not exist. </exception> <exception cref="T:Amazon.Route53.Model.TooManyHostedZonesException"> This error indicates that you've reached the maximum number of hosted zones that can be created for the current AWS account. You can request an increase to the limit on the <a href="http://aws.amazon.com/route53-request/">Contact Us</a> page. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.CreateHostedZoneAsync(Amazon.Route53.Model.CreateHostedZoneRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateHostedZone operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateHostedZone operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.CreateReusableDelegationSet(Amazon.Route53.Model.CreateReusableDelegationSetRequest)"> <summary> This action creates a reusable delegationSet. <para> To create a new reusable delegationSet, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/delegationset</code> resource. The request body must include a 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> <param name="request">Container for the necessary parameters to execute the CreateReusableDelegationSet service method.</param> <returns>The response from the CreateReusableDelegationSet service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.DelegationSetAlreadyCreatedException"> A delegation set with the same owner and caller reference combination has already been created. </exception> <exception cref="T:Amazon.Route53.Model.DelegationSetAlreadyReusableException"> The specified delegation set has already been marked as reusable. </exception> <exception cref="T:Amazon.Route53.Model.DelegationSetNotAvailableException"> Amazon Route 53 allows some duplicate domain names, but there is a maximum number of duplicate names. This error indicates that you have reached that maximum. If you want to create another hosted zone with the same name and Amazon Route 53 generates this error, you can request an increase to the limit on the <a href="http://aws.amazon.com/route53-request/">Contact Us</a> page. </exception> <exception cref="T:Amazon.Route53.Model.HostedZoneNotFoundException"> The specified HostedZone cannot be found. </exception> <exception cref="T:Amazon.Route53.Model.InvalidArgumentException"> At least one of the specified arguments is invalid. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.LimitsExceededException"> The limits specified for a resource have been exceeded. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.CreateReusableDelegationSetAsync(Amazon.Route53.Model.CreateReusableDelegationSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateReusableDelegationSet operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateReusableDelegationSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.CreateTrafficPolicy(Amazon.Route53.Model.CreateTrafficPolicyRequest)"> <summary> 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>/<i>Route 53 API version</i>/trafficpolicy</code> resource. The request body must include a 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> <param name="request">Container for the necessary parameters to execute the CreateTrafficPolicy service method.</param> <returns>The response from the CreateTrafficPolicy service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.InvalidTrafficPolicyDocumentException"> The format of the traffic policy document that you specified in the <code>Document</code> element is invalid. </exception> <exception cref="T:Amazon.Route53.Model.TooManyTrafficPoliciesException"> You've created the maximum number of traffic policies that can be created for the current AWS account. You can request an increase to the limit on the <a href="http://aws.amazon.com/route53-request/">Contact Us</a> page. </exception> <exception cref="T:Amazon.Route53.Model.TrafficPolicyAlreadyExistsException"> A traffic policy that has the same value for <code>Name</code> already exists. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.CreateTrafficPolicyAsync(Amazon.Route53.Model.CreateTrafficPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTrafficPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrafficPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.CreateTrafficPolicyInstance(Amazon.Route53.Model.CreateTrafficPolicyInstanceRequest)"> <summary> 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>/<i>Route 53 API version</i>/trafficpolicyinstance</code> resource. The request body must include a 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> <param name="request">Container for the necessary parameters to execute the CreateTrafficPolicyInstance service method.</param> <returns>The response from the CreateTrafficPolicyInstance service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyException"> No traffic policy exists with the specified ID. </exception> <exception cref="T:Amazon.Route53.Model.TooManyTrafficPolicyInstancesException"> You've created the maximum number of traffic policy instances that can be created for the current AWS account. You can request an increase to the limit on the <a href="http://aws.amazon.com/route53-request/">Contact Us</a> page. </exception> <exception cref="T:Amazon.Route53.Model.TrafficPolicyInstanceAlreadyExistsException"> Traffic policy instance with given Id already exists. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.CreateTrafficPolicyInstanceAsync(Amazon.Route53.Model.CreateTrafficPolicyInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTrafficPolicyInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrafficPolicyInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.CreateTrafficPolicyVersion(Amazon.Route53.Model.CreateTrafficPolicyVersionRequest)"> <summary> 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>/<i>Route 53 API version</i>/trafficpolicy/</code> resource. The request body includes a 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> <param name="request">Container for the necessary parameters to execute the CreateTrafficPolicyVersion service method.</param> <returns>The response from the CreateTrafficPolicyVersion service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.ConcurrentModificationException"> Another user submitted a request to update the object at the same time that you did. Retry the request. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.InvalidTrafficPolicyDocumentException"> The format of the traffic policy document that you specified in the <code>Document</code> element is invalid. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyException"> No traffic policy exists with the specified ID. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.CreateTrafficPolicyVersionAsync(Amazon.Route53.Model.CreateTrafficPolicyVersionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTrafficPolicyVersion operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrafficPolicyVersion operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.DeleteHealthCheck(Amazon.Route53.Model.DeleteHealthCheckRequest)"> <summary> This action deletes a health check. To delete a health check, send a <code>DELETE</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the DeleteHealthCheck service method.</param> <returns>The response from the DeleteHealthCheck service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.HealthCheckInUseException"> There are resource records associated with this health check. Before you can delete the health check, you must disassociate it from the resource record sets. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.DeleteHealthCheckAsync(Amazon.Route53.Model.DeleteHealthCheckRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteHealthCheck operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHealthCheck operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.DeleteHostedZone(Amazon.Route53.Model.DeleteHostedZoneRequest)"> <summary> This action deletes a hosted zone. To delete a hosted zone, send a <code>DELETE</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the DeleteHostedZone service method.</param> <returns>The response from the DeleteHostedZone service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.HostedZoneNotEmptyException"> The hosted zone contains resource record sets in addition to the default NS and SOA resource record sets. Before you can delete the hosted zone, you must delete the additional resource record sets. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.PriorRequestNotCompleteException"> The request was rejected because Amazon Route 53 was still processing a prior request. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.DeleteHostedZoneAsync(Amazon.Route53.Model.DeleteHostedZoneRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteHostedZone operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHostedZone operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.DeleteReusableDelegationSet(Amazon.Route53.Model.DeleteReusableDelegationSetRequest)"> <summary> This action deletes a reusable delegation set. To delete a reusable delegation set, send a <code>DELETE</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the DeleteReusableDelegationSet service method.</param> <returns>The response from the DeleteReusableDelegationSet service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.DelegationSetInUseException"> The specified delegation contains associated hosted zones which must be deleted before the reusable delegation set can be deleted. </exception> <exception cref="T:Amazon.Route53.Model.DelegationSetNotReusableException"> The specified delegation set has not been marked as reusable. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchDelegationSetException"> The specified delegation set does not exist. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.DeleteReusableDelegationSetAsync(Amazon.Route53.Model.DeleteReusableDelegationSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteReusableDelegationSet operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteReusableDelegationSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.DeleteTrafficPolicy(Amazon.Route53.Model.DeleteTrafficPolicyRequest)"> <summary> Deletes a traffic policy. To delete a traffic policy, send a <code>DELETE</code> request to the <code>/<i>Route 53 API version</i>/trafficpolicy</code> resource. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrafficPolicy service method.</param> <returns>The response from the DeleteTrafficPolicy service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.ConcurrentModificationException"> Another user submitted a request to update the object at the same time that you did. Retry the request. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyException"> No traffic policy exists with the specified ID. </exception> <exception cref="T:Amazon.Route53.Model.TrafficPolicyInUseException"> One or more traffic policy instances were created by using the specified traffic policy. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.DeleteTrafficPolicyAsync(Amazon.Route53.Model.DeleteTrafficPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTrafficPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrafficPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.DeleteTrafficPolicyInstance(Amazon.Route53.Model.DeleteTrafficPolicyInstanceRequest)"> <summary> 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>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the DeleteTrafficPolicyInstance service method.</param> <returns>The response from the DeleteTrafficPolicyInstance service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyInstanceException"> No traffic policy instance exists with the specified ID. </exception> <exception cref="T:Amazon.Route53.Model.PriorRequestNotCompleteException"> The request was rejected because Amazon Route 53 was still processing a prior request. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.DeleteTrafficPolicyInstanceAsync(Amazon.Route53.Model.DeleteTrafficPolicyInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTrafficPolicyInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrafficPolicyInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.DisassociateVPCFromHostedZone(Amazon.Route53.Model.DisassociateVPCFromHostedZoneRequest)"> <summary> 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>/<i>Route 53 API version</i>/hostedzone/<i>hosted zone ID</i>/disassociatevpc</code> resource. The request body must include a 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> <param name="request">Container for the necessary parameters to execute the DisassociateVPCFromHostedZone service method.</param> <returns>The response from the DisassociateVPCFromHostedZone service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.InvalidVPCIdException"> The hosted zone you are trying to create for your VPC_ID does not belong to you. Amazon Route 53 returns this error when the VPC specified by <code>VPCId</code> does not belong to you. </exception> <exception cref="T:Amazon.Route53.Model.LastVPCAssociationException"> The VPC you are trying to disassociate from the hosted zone is the last the VPC that is associated with the hosted zone. Amazon Route 53 currently doesn't support disassociate the last VPC from the hosted zone. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.VPCAssociationNotFoundException"> The VPC you specified is not currently associated with the hosted zone. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.DisassociateVPCFromHostedZoneAsync(Amazon.Route53.Model.DisassociateVPCFromHostedZoneRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisassociateVPCFromHostedZone operation. </summary> <param name="request">Container for the necessary parameters to execute the DisassociateVPCFromHostedZone operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetChange(Amazon.Route53.Model.GetChangeRequest)"> <summary> 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> <param name="request">Container for the necessary parameters to execute the GetChange service method.</param> <returns>The response from the GetChange service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchChangeException"> </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetChangeAsync(Amazon.Route53.Model.GetChangeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetChange operation. </summary> <param name="request">Container for the necessary parameters to execute the GetChange operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetChangeDetails(Amazon.Route53.Model.GetChangeDetailsRequest)"> <summary> This action returns the status and changes of a change batch request. </summary> <param name="request">Container for the necessary parameters to execute the GetChangeDetails service method.</param> <returns>The response from the GetChangeDetails service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchChangeException"> </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetChangeDetailsAsync(Amazon.Route53.Model.GetChangeDetailsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetChangeDetails operation. </summary> <param name="request">Container for the necessary parameters to execute the GetChangeDetails operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetCheckerIpRanges(Amazon.Route53.Model.GetCheckerIpRangesRequest)"> <summary> 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>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the GetCheckerIpRanges service method.</param> <returns>The response from the GetCheckerIpRanges service method, as returned by Route53.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetCheckerIpRangesAsync(Amazon.Route53.Model.GetCheckerIpRangesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetCheckerIpRanges operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCheckerIpRanges operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetGeoLocation(Amazon.Route53.Model.GetGeoLocationRequest)"> <summary> To retrieve a single geo location, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/geolocation</code> resource with one of these options: continentcode | countrycode | countrycode and subdivisioncode. </summary> <param name="request">Container for the necessary parameters to execute the GetGeoLocation service method.</param> <returns>The response from the GetGeoLocation service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchGeoLocationException"> The geo location you are trying to get does not exist. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetGeoLocationAsync(Amazon.Route53.Model.GetGeoLocationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetGeoLocation operation. </summary> <param name="request">Container for the necessary parameters to execute the GetGeoLocation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetHealthCheck(Amazon.Route53.Model.GetHealthCheckRequest)"> <summary> To retrieve the health check, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/healthcheck/<i>health check ID</i></code> resource. </summary> <param name="request">Container for the necessary parameters to execute the GetHealthCheck service method.</param> <returns>The response from the GetHealthCheck service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.IncompatibleVersionException"> The resource you are trying to access is unsupported on this Amazon Route 53 endpoint. Please consider using a newer endpoint or a tool that does so. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetHealthCheckAsync(Amazon.Route53.Model.GetHealthCheckRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetHealthCheck operation. </summary> <param name="request">Container for the necessary parameters to execute the GetHealthCheck operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetHealthCheckCount(Amazon.Route53.Model.GetHealthCheckCountRequest)"> <summary> To retrieve a count of all your health checks, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/healthcheckcount</code> resource. </summary> <param name="request">Container for the necessary parameters to execute the GetHealthCheckCount service method.</param> <returns>The response from the GetHealthCheckCount service method, as returned by Route53.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetHealthCheckCountAsync(Amazon.Route53.Model.GetHealthCheckCountRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetHealthCheckCount operation. </summary> <param name="request">Container for the necessary parameters to execute the GetHealthCheckCount operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetHealthCheckLastFailureReason(Amazon.Route53.Model.GetHealthCheckLastFailureReasonRequest)"> <summary> 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>/<i>Route 53 API version</i>/healthcheck/<i>health check ID</i>/lastfailurereason</code> resource. </summary> <param name="request">Container for the necessary parameters to execute the GetHealthCheckLastFailureReason service method.</param> <returns>The response from the GetHealthCheckLastFailureReason service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetHealthCheckLastFailureReasonAsync(Amazon.Route53.Model.GetHealthCheckLastFailureReasonRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetHealthCheckLastFailureReason operation. </summary> <param name="request">Container for the necessary parameters to execute the GetHealthCheckLastFailureReason operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetHealthCheckStatus(Amazon.Route53.Model.GetHealthCheckStatusRequest)"> <summary> To retrieve the health check status, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/healthcheck/<i>health check ID</i>/status</code> resource. You can use this call to get a health check's current status. </summary> <param name="request">Container for the necessary parameters to execute the GetHealthCheckStatus service method.</param> <returns>The response from the GetHealthCheckStatus service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetHealthCheckStatusAsync(Amazon.Route53.Model.GetHealthCheckStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetHealthCheckStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the GetHealthCheckStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetHostedZone(Amazon.Route53.Model.GetHostedZoneRequest)"> <summary> To retrieve the delegation set for a hosted zone, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the GetHostedZone service method.</param> <returns>The response from the GetHostedZone service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetHostedZoneAsync(Amazon.Route53.Model.GetHostedZoneRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetHostedZone operation. </summary> <param name="request">Container for the necessary parameters to execute the GetHostedZone operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetHostedZoneCount"> <summary> To retrieve a count of all your hosted zones, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/hostedzonecount</code> resource. </summary> <returns>The response from the GetHostedZoneCount service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetHostedZoneCount(Amazon.Route53.Model.GetHostedZoneCountRequest)"> <summary> To retrieve a count of all your hosted zones, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/hostedzonecount</code> resource. </summary> <param name="request">Container for the necessary parameters to execute the GetHostedZoneCount service method.</param> <returns>The response from the GetHostedZoneCount service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetHostedZoneCountAsync(Amazon.Route53.Model.GetHostedZoneCountRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetHostedZoneCount operation. </summary> <param name="request">Container for the necessary parameters to execute the GetHostedZoneCount operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetReusableDelegationSet(Amazon.Route53.Model.GetReusableDelegationSetRequest)"> <summary> To retrieve the reusable delegation set, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/delegationset/<i>delegation set ID</i></code> resource. </summary> <param name="request">Container for the necessary parameters to execute the GetReusableDelegationSet service method.</param> <returns>The response from the GetReusableDelegationSet service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.DelegationSetNotReusableException"> The specified delegation set has not been marked as reusable. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchDelegationSetException"> The specified delegation set does not exist. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetReusableDelegationSetAsync(Amazon.Route53.Model.GetReusableDelegationSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetReusableDelegationSet operation. </summary> <param name="request">Container for the necessary parameters to execute the GetReusableDelegationSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetTrafficPolicy(Amazon.Route53.Model.GetTrafficPolicyRequest)"> <summary> Gets information about a specific traffic policy version. To get the information, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/trafficpolicy</code> resource. </summary> <param name="request">Container for the necessary parameters to execute the GetTrafficPolicy service method.</param> <returns>The response from the GetTrafficPolicy service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyException"> No traffic policy exists with the specified ID. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetTrafficPolicyAsync(Amazon.Route53.Model.GetTrafficPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetTrafficPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTrafficPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetTrafficPolicyInstance(Amazon.Route53.Model.GetTrafficPolicyInstanceRequest)"> <summary> 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>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the GetTrafficPolicyInstance service method.</param> <returns>The response from the GetTrafficPolicyInstance service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyInstanceException"> No traffic policy instance exists with the specified ID. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetTrafficPolicyInstanceAsync(Amazon.Route53.Model.GetTrafficPolicyInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetTrafficPolicyInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTrafficPolicyInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetTrafficPolicyInstanceCount(Amazon.Route53.Model.GetTrafficPolicyInstanceCountRequest)"> <summary> 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>/<i>Route 53 API version</i>/trafficpolicyinstancecount</code> resource. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetTrafficPolicyInstanceCount service method.</param> <returns>The response from the GetTrafficPolicyInstanceCount service method, as returned by Route53.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.GetTrafficPolicyInstanceCountAsync(Amazon.Route53.Model.GetTrafficPolicyInstanceCountRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetTrafficPolicyInstanceCount operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTrafficPolicyInstanceCount operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListChangeBatchesByHostedZone(Amazon.Route53.Model.ListChangeBatchesByHostedZoneRequest)"> <summary> This action gets the list of ChangeBatches in a given time period for a given hosted zone. </summary> <param name="request">Container for the necessary parameters to execute the ListChangeBatchesByHostedZone service method.</param> <returns>The response from the ListChangeBatchesByHostedZone service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListChangeBatchesByHostedZoneAsync(Amazon.Route53.Model.ListChangeBatchesByHostedZoneRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListChangeBatchesByHostedZone operation. </summary> <param name="request">Container for the necessary parameters to execute the ListChangeBatchesByHostedZone operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListChangeBatchesByRRSet(Amazon.Route53.Model.ListChangeBatchesByRRSetRequest)"> <summary> This action gets the list of ChangeBatches in a given time period for a given hosted zone and RRSet. </summary> <param name="request">Container for the necessary parameters to execute the ListChangeBatchesByRRSet service method.</param> <returns>The response from the ListChangeBatchesByRRSet service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListChangeBatchesByRRSetAsync(Amazon.Route53.Model.ListChangeBatchesByRRSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListChangeBatchesByRRSet operation. </summary> <param name="request">Container for the necessary parameters to execute the ListChangeBatchesByRRSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListGeoLocations"> <summary> To retrieve a list of supported geo locations, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <returns>The response from the ListGeoLocations service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListGeoLocations(Amazon.Route53.Model.ListGeoLocationsRequest)"> <summary> To retrieve a list of supported geo locations, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListGeoLocations service method.</param> <returns>The response from the ListGeoLocations service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListGeoLocationsAsync(Amazon.Route53.Model.ListGeoLocationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListGeoLocations operation. </summary> <param name="request">Container for the necessary parameters to execute the ListGeoLocations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListHealthChecks"> <summary> To retrieve a list of your health checks, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <returns>The response from the ListHealthChecks service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.IncompatibleVersionException"> The resource you are trying to access is unsupported on this Amazon Route 53 endpoint. Please consider using a newer endpoint or a tool that does so. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListHealthChecks(Amazon.Route53.Model.ListHealthChecksRequest)"> <summary> To retrieve a list of your health checks, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListHealthChecks service method.</param> <returns>The response from the ListHealthChecks service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.IncompatibleVersionException"> The resource you are trying to access is unsupported on this Amazon Route 53 endpoint. Please consider using a newer endpoint or a tool that does so. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListHealthChecksAsync(Amazon.Route53.Model.ListHealthChecksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListHealthChecks operation. </summary> <param name="request">Container for the necessary parameters to execute the ListHealthChecks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListHostedZones"> <summary> To retrieve a list of your hosted zones, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <returns>The response from the ListHostedZones service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.DelegationSetNotReusableException"> The specified delegation set has not been marked as reusable. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchDelegationSetException"> The specified delegation set does not exist. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListHostedZones(Amazon.Route53.Model.ListHostedZonesRequest)"> <summary> To retrieve a list of your hosted zones, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListHostedZones service method.</param> <returns>The response from the ListHostedZones service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.DelegationSetNotReusableException"> The specified delegation set has not been marked as reusable. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchDelegationSetException"> The specified delegation set does not exist. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListHostedZonesAsync(Amazon.Route53.Model.ListHostedZonesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListHostedZones operation. </summary> <param name="request">Container for the necessary parameters to execute the ListHostedZones operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListHostedZonesByName(Amazon.Route53.Model.ListHostedZonesByNameRequest)"> <summary> To retrieve a list of your hosted zones in lexicographic order, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListHostedZonesByName service method.</param> <returns>The response from the ListHostedZonesByName service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidDomainNameException"> This error indicates that the specified domain name is not valid. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListHostedZonesByNameAsync(Amazon.Route53.Model.ListHostedZonesByNameRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListHostedZonesByName operation. </summary> <param name="request">Container for the necessary parameters to execute the ListHostedZonesByName operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListResourceRecordSets(Amazon.Route53.Model.ListResourceRecordSetsRequest)"> <summary> 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> <param name="request">Container for the necessary parameters to execute the ListResourceRecordSets service method.</param> <returns>The response from the ListResourceRecordSets service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListResourceRecordSetsAsync(Amazon.Route53.Model.ListResourceRecordSetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListResourceRecordSets operation. </summary> <param name="request">Container for the necessary parameters to execute the ListResourceRecordSets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListReusableDelegationSets"> <summary> To retrieve a list of your reusable delegation sets, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <returns>The response from the ListReusableDelegationSets service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListReusableDelegationSets(Amazon.Route53.Model.ListReusableDelegationSetsRequest)"> <summary> To retrieve a list of your reusable delegation sets, send a <code>GET</code> request to the <code>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListReusableDelegationSets service method.</param> <returns>The response from the ListReusableDelegationSets service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListReusableDelegationSetsAsync(Amazon.Route53.Model.ListReusableDelegationSetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListReusableDelegationSets operation. </summary> <param name="request">Container for the necessary parameters to execute the ListReusableDelegationSets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListTagsForResource(Amazon.Route53.Model.ListTagsForResourceRequest)"> <summary> </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResource service method.</param> <returns>The response from the ListTagsForResource service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.PriorRequestNotCompleteException"> The request was rejected because Amazon Route 53 was still processing a prior request. </exception> <exception cref="T:Amazon.Route53.Model.ThrottlingException"> </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListTagsForResourceAsync(Amazon.Route53.Model.ListTagsForResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTagsForResource operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListTagsForResources(Amazon.Route53.Model.ListTagsForResourcesRequest)"> <summary> </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResources service method.</param> <returns>The response from the ListTagsForResources service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.PriorRequestNotCompleteException"> The request was rejected because Amazon Route 53 was still processing a prior request. </exception> <exception cref="T:Amazon.Route53.Model.ThrottlingException"> </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListTagsForResourcesAsync(Amazon.Route53.Model.ListTagsForResourcesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTagsForResources operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResources operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListTrafficPolicies(Amazon.Route53.Model.ListTrafficPoliciesRequest)"> <summary> 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>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicies service method.</param> <returns>The response from the ListTrafficPolicies service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListTrafficPoliciesAsync(Amazon.Route53.Model.ListTrafficPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTrafficPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListTrafficPolicyInstances(Amazon.Route53.Model.ListTrafficPolicyInstancesRequest)"> <summary> 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>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicyInstances service method.</param> <returns>The response from the ListTrafficPolicyInstances service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyInstanceException"> No traffic policy instance exists with the specified ID. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListTrafficPolicyInstancesAsync(Amazon.Route53.Model.ListTrafficPolicyInstancesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTrafficPolicyInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicyInstances operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListTrafficPolicyInstancesByHostedZone(Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneRequest)"> <summary> 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>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicyInstancesByHostedZone service method.</param> <returns>The response from the ListTrafficPolicyInstancesByHostedZone service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyInstanceException"> No traffic policy instance exists with the specified ID. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListTrafficPolicyInstancesByHostedZoneAsync(Amazon.Route53.Model.ListTrafficPolicyInstancesByHostedZoneRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTrafficPolicyInstancesByHostedZone operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicyInstancesByHostedZone operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListTrafficPolicyInstancesByPolicy(Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyRequest)"> <summary> 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>/<i>Route 53 API version</i>/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> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicyInstancesByPolicy service method.</param> <returns>The response from the ListTrafficPolicyInstancesByPolicy service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyException"> No traffic policy exists with the specified ID. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyInstanceException"> No traffic policy instance exists with the specified ID. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListTrafficPolicyInstancesByPolicyAsync(Amazon.Route53.Model.ListTrafficPolicyInstancesByPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTrafficPolicyInstancesByPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicyInstancesByPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListTrafficPolicyVersions(Amazon.Route53.Model.ListTrafficPolicyVersionsRequest)"> <summary> 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> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicyVersions service method.</param> <returns>The response from the ListTrafficPolicyVersions service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyException"> No traffic policy exists with the specified ID. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.ListTrafficPolicyVersionsAsync(Amazon.Route53.Model.ListTrafficPolicyVersionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTrafficPolicyVersions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTrafficPolicyVersions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.UpdateHealthCheck(Amazon.Route53.Model.UpdateHealthCheckRequest)"> <summary> This action updates an existing health check. <para> To update a health check, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/healthcheck/<i>health check ID</i></code> resource. The request body must include a document with an <code>UpdateHealthCheckRequest</code> element. The response returns an <code>UpdateHealthCheckResponse</code> element, which contains metadata about the health check. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateHealthCheck service method.</param> <returns>The response from the UpdateHealthCheck service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.HealthCheckVersionMismatchException"> </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHealthCheckException"> The health check you are trying to get or delete does not exist. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.UpdateHealthCheckAsync(Amazon.Route53.Model.UpdateHealthCheckRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateHealthCheck operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateHealthCheck operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.UpdateHostedZoneComment(Amazon.Route53.Model.UpdateHostedZoneCommentRequest)"> <summary> To update the hosted zone comment, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/hostedzone/<i>hosted zone ID</i></code> resource. The request body must include a document with a <code>UpdateHostedZoneCommentRequest</code> element. The response to this request includes the modified <code>HostedZone</code> element. <note> The comment can have a maximum length of 256 characters.</note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateHostedZoneComment service method.</param> <returns>The response from the UpdateHostedZoneComment service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchHostedZoneException"> </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.UpdateHostedZoneCommentAsync(Amazon.Route53.Model.UpdateHostedZoneCommentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateHostedZoneComment operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateHostedZoneComment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.UpdateTrafficPolicyComment(Amazon.Route53.Model.UpdateTrafficPolicyCommentRequest)"> <summary> Updates the comment for a specified traffic policy version. <para> To update the comment, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/trafficpolicy/</code> resource. </para> <para> The request body must include a document with an <code>UpdateTrafficPolicyCommentRequest</code> element. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateTrafficPolicyComment service method.</param> <returns>The response from the UpdateTrafficPolicyComment service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.ConcurrentModificationException"> Another user submitted a request to update the object at the same time that you did. Retry the request. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyException"> No traffic policy exists with the specified ID. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.UpdateTrafficPolicyCommentAsync(Amazon.Route53.Model.UpdateTrafficPolicyCommentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateTrafficPolicyComment operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTrafficPolicyComment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.UpdateTrafficPolicyInstance(Amazon.Route53.Model.UpdateTrafficPolicyInstanceRequest)"> <summary> Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version. <important>The DNS type of the resource record sets that you're updating must match the DNS type in the JSON document that is associated with the traffic policy version that you're using to update the traffic policy instance.</important> <para> When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Amazon Route 53 performs the following operations: </para> <ol> <li>Amazon Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how substantial the differences are between the existing resource record sets and the new resource record sets. </li> <li>When all of the new resource record sets have been created, Amazon Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.</li> <li>Amazon Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.</li> </ol> <para> To update a traffic policy instance, send a <code>POST</code> request to the <code>/<i>Route 53 API version</i>/trafficpolicyinstance/<i>traffic policy ID</i></code> resource. The request body must include a document with an <code>UpdateTrafficPolicyInstanceRequest</code> element. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateTrafficPolicyInstance service method.</param> <returns>The response from the UpdateTrafficPolicyInstance service method, as returned by Route53.</returns> <exception cref="T:Amazon.Route53.Model.ConflictingTypesException"> You tried to update a traffic policy instance by using a traffic policy version that has a different DNS type than the current type for the instance. You specified the type in the JSON document in the <code>CreateTrafficPolicy</code> or <code>CreateTrafficPolicyVersion</code>request. </exception> <exception cref="T:Amazon.Route53.Model.InvalidInputException"> Some value specified in the request is invalid or the XML document is malformed. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyException"> No traffic policy exists with the specified ID. </exception> <exception cref="T:Amazon.Route53.Model.NoSuchTrafficPolicyInstanceException"> No traffic policy instance exists with the specified ID. </exception> <exception cref="T:Amazon.Route53.Model.PriorRequestNotCompleteException"> The request was rejected because Amazon Route 53 was still processing a prior request. </exception> </member> <member name="M:Amazon.Route53.AmazonRoute53Client.UpdateTrafficPolicyInstanceAsync(Amazon.Route53.Model.UpdateTrafficPolicyInstanceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateTrafficPolicyInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTrafficPolicyInstance operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.Route53Domains.AmazonRoute53DomainsClient"> <summary> Implementation for accessing Route53Domains </summary> </member> <member name="T:Amazon.Route53Domains.IAmazonRoute53Domains"> <summary> Interface for accessing Route53Domains </summary> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.CheckDomainAvailability(Amazon.Route53Domains.Model.CheckDomainAvailabilityRequest)"> <summary> This operation checks the availability of one domain name. You can access this API without authenticating. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name. </summary> <param name="request">Container for the necessary parameters to execute the CheckDomainAvailability service method.</param> <returns>The response from the CheckDomainAvailability service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.CheckDomainAvailabilityAsync(Amazon.Route53Domains.Model.CheckDomainAvailabilityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CheckDomainAvailability operation. </summary> <param name="request">Container for the necessary parameters to execute the CheckDomainAvailability operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.DeleteTagsForDomain(System.String,System.Collections.Generic.List{System.String})"> <summary> This operation deletes the specified tags for a domain. <para> All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. </para> </summary> <param name="domainName">The domain for which you want to delete one or more tags. The name of a domain. Type: String Default: None Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when theyaposre surrounded by letters, numbers, or other hyphens. You canapost specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode. Required: Yes</param> <param name="tagsToDelete">A list of tag keys to delete. Type: A list that contains the keys of the tags that you want to delete. Default: None Required: No'></param> <returns>The response from the DeleteTagsForDomain service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.DeleteTagsForDomain(Amazon.Route53Domains.Model.DeleteTagsForDomainRequest)"> <summary> This operation deletes the specified tags for a domain. <para> All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteTagsForDomain service method.</param> <returns>The response from the DeleteTagsForDomain service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.DeleteTagsForDomainAsync(Amazon.Route53Domains.Model.DeleteTagsForDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTagsForDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTagsForDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.DisableDomainAutoRenew(Amazon.Route53Domains.Model.DisableDomainAutoRenewRequest)"> <summary> This operation disables automatic renewal of domain registration for the specified domain. <note>Caution! Amazon Route 53 doesn't have a manual renewal process, so if you disable automatic renewal, registration for the domain will not be renewed when the expiration date passes, and you will lose control of the domain name.</note> </summary> <param name="request">Container for the necessary parameters to execute the DisableDomainAutoRenew service method.</param> <returns>The response from the DisableDomainAutoRenew service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.DisableDomainAutoRenewAsync(Amazon.Route53Domains.Model.DisableDomainAutoRenewRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableDomainAutoRenew operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableDomainAutoRenew operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.DisableDomainTransferLock(Amazon.Route53Domains.Model.DisableDomainTransferLockRequest)"> <summary> This operation removes the transfer lock on the domain (specifically the <code>clientTransferProhibited</code> status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </summary> <param name="request">Container for the necessary parameters to execute the DisableDomainTransferLock service method.</param> <returns>The response from the DisableDomainTransferLock service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.DuplicateRequestException"> The request is already in progress for the domain. </exception> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.TLDRulesViolationException"> The top-level domain does not support this operation. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.DisableDomainTransferLockAsync(Amazon.Route53Domains.Model.DisableDomainTransferLockRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableDomainTransferLock operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableDomainTransferLock operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.EnableDomainAutoRenew(Amazon.Route53Domains.Model.EnableDomainAutoRenewRequest)"> <summary> This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account. <para> The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see <a href="http://wiki.gandi.net/en/domains/renew#renewal_restoration_and_deletion_times">"Renewal, restoration, and deletion times"</a> on the website for our registrar partner, Gandi. Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline. </para> </summary> <param name="request">Container for the necessary parameters to execute the EnableDomainAutoRenew service method.</param> <returns>The response from the EnableDomainAutoRenew service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.EnableDomainAutoRenewAsync(Amazon.Route53Domains.Model.EnableDomainAutoRenewRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableDomainAutoRenew operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableDomainAutoRenew operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.EnableDomainTransferLock(Amazon.Route53Domains.Model.EnableDomainTransferLockRequest)"> <summary> This operation sets the transfer lock on the domain (specifically the <code>clientTransferProhibited</code> status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </summary> <param name="request">Container for the necessary parameters to execute the EnableDomainTransferLock service method.</param> <returns>The response from the EnableDomainTransferLock service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.DuplicateRequestException"> The request is already in progress for the domain. </exception> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.TLDRulesViolationException"> The top-level domain does not support this operation. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.EnableDomainTransferLockAsync(Amazon.Route53Domains.Model.EnableDomainTransferLockRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableDomainTransferLock operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableDomainTransferLock operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.GetDomainDetail(Amazon.Route53Domains.Model.GetDomainDetailRequest)"> <summary> This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output. </summary> <param name="request">Container for the necessary parameters to execute the GetDomainDetail service method.</param> <returns>The response from the GetDomainDetail service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.GetDomainDetailAsync(Amazon.Route53Domains.Model.GetDomainDetailRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDomainDetail operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDomainDetail operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.GetOperationDetail(Amazon.Route53Domains.Model.GetOperationDetailRequest)"> <summary> This operation returns the current status of an operation that is not completed. </summary> <param name="request">Container for the necessary parameters to execute the GetOperationDetail service method.</param> <returns>The response from the GetOperationDetail service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.GetOperationDetailAsync(Amazon.Route53Domains.Model.GetOperationDetailRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetOperationDetail operation. </summary> <param name="request">Container for the necessary parameters to execute the GetOperationDetail operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.ListDomains"> <summary> This operation returns all the domain names registered with Amazon Route 53 for the current AWS account. </summary> <returns>The response from the ListDomains service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.ListDomains(Amazon.Route53Domains.Model.ListDomainsRequest)"> <summary> This operation returns all the domain names registered with Amazon Route 53 for the current AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDomains service method.</param> <returns>The response from the ListDomains service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.ListDomainsAsync(Amazon.Route53Domains.Model.ListDomainsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDomains operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDomains operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.ListOperations"> <summary> This operation returns the operation IDs of operations that are not yet complete. </summary> <returns>The response from the ListOperations service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.ListOperations(Amazon.Route53Domains.Model.ListOperationsRequest)"> <summary> This operation returns the operation IDs of operations that are not yet complete. </summary> <param name="request">Container for the necessary parameters to execute the ListOperations service method.</param> <returns>The response from the ListOperations service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.ListOperationsAsync(Amazon.Route53Domains.Model.ListOperationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListOperations operation. </summary> <param name="request">Container for the necessary parameters to execute the ListOperations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.ListTagsForDomain(System.String)"> <summary> This operation returns all of the tags that are associated with the specified domain. <para> All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. </para> </summary> <param name="domainName">The domain for which you want to get a list of tags.</param> <returns>The response from the ListTagsForDomain service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.ListTagsForDomain(Amazon.Route53Domains.Model.ListTagsForDomainRequest)"> <summary> This operation returns all of the tags that are associated with the specified domain. <para> All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForDomain service method.</param> <returns>The response from the ListTagsForDomain service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.ListTagsForDomainAsync(Amazon.Route53Domains.Model.ListTagsForDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTagsForDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.RegisterDomain(Amazon.Route53Domains.Model.RegisterDomainRequest)"> <summary> This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. For some top-level domains (TLDs), this operation requires extra parameters. <para> When you register a domain, Amazon Route 53 does the following: </para> <ul> <li>Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.</li> <li>Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.</li> <li>Optionally enables privacy protection, so WHOIS queries return contact information for our registrar partner, Gandi, instead of the information you entered for registrant, admin, and tech contacts.</li> <li>If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email.</li> <li>Charges your AWS account an amount based on the top-level domain. For more information, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the RegisterDomain service method.</param> <returns>The response from the RegisterDomain service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.DomainLimitExceededException"> The number of domains has exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.DuplicateRequestException"> The request is already in progress for the domain. </exception> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.TLDRulesViolationException"> The top-level domain does not support this operation. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.RegisterDomainAsync(Amazon.Route53Domains.Model.RegisterDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.RetrieveDomainAuthCode(Amazon.Route53Domains.Model.RetrieveDomainAuthCodeRequest)"> <summary> This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar. </summary> <param name="request">Container for the necessary parameters to execute the RetrieveDomainAuthCode service method.</param> <returns>The response from the RetrieveDomainAuthCode service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.RetrieveDomainAuthCodeAsync(Amazon.Route53Domains.Model.RetrieveDomainAuthCodeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RetrieveDomainAuthCode operation. </summary> <param name="request">Container for the necessary parameters to execute the RetrieveDomainAuthCode operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.TransferDomain(Amazon.Route53Domains.Model.TransferDomainRequest)"> <summary> This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered with the AWS registrar partner, Gandi. <para> For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-to-route-53.html">Transferring Registration for a Domain to Amazon Route 53</a> in the Amazon Route 53 Developer Guide. </para> <para> If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you consider transferring your DNS service to Amazon Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time. </para> <note>Caution! If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable.</note> <para> If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email. </para> </summary> <param name="request">Container for the necessary parameters to execute the TransferDomain service method.</param> <returns>The response from the TransferDomain service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.DomainLimitExceededException"> The number of domains has exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.DuplicateRequestException"> The request is already in progress for the domain. </exception> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.TLDRulesViolationException"> The top-level domain does not support this operation. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.TransferDomainAsync(Amazon.Route53Domains.Model.TransferDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TransferDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the TransferDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.UpdateDomainContact(Amazon.Route53Domains.Model.UpdateDomainContactRequest)"> <summary> This operation updates the contact information for a particular domain. Information for at least one contact (registrant, administrator, or technical) must be supplied for update. <para> If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateDomainContact service method.</param> <returns>The response from the UpdateDomainContact service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.DuplicateRequestException"> The request is already in progress for the domain. </exception> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.TLDRulesViolationException"> The top-level domain does not support this operation. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.UpdateDomainContactAsync(Amazon.Route53Domains.Model.UpdateDomainContactRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDomainContact operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDomainContact operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.UpdateDomainContactPrivacy(Amazon.Route53Domains.Model.UpdateDomainContactPrivacyRequest)"> <summary> This operation updates the specified domain contact's privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the <a href="http://www.gandi.net/domain/whois/?currency=USD&amp;lang=en">Gandi privacy features</a>. <para> This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateDomainContactPrivacy service method.</param> <returns>The response from the UpdateDomainContactPrivacy service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.DuplicateRequestException"> The request is already in progress for the domain. </exception> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.TLDRulesViolationException"> The top-level domain does not support this operation. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.UpdateDomainContactPrivacyAsync(Amazon.Route53Domains.Model.UpdateDomainContactPrivacyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDomainContactPrivacy operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDomainContactPrivacy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.UpdateDomainNameservers(Amazon.Route53Domains.Model.UpdateDomainNameserversRequest)"> <summary> This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain. <para> If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateDomainNameservers service method.</param> <returns>The response from the UpdateDomainNameservers service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.DuplicateRequestException"> The request is already in progress for the domain. </exception> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.TLDRulesViolationException"> The top-level domain does not support this operation. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.UpdateDomainNameserversAsync(Amazon.Route53Domains.Model.UpdateDomainNameserversRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDomainNameservers operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDomainNameservers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.UpdateTagsForDomain(System.String,System.Collections.Generic.List{Amazon.Route53Domains.Model.Tag})"> <summary> This operation adds or updates tags for a specified domain. <para> All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. </para> </summary> <param name="domainName">The domain for which you want to add or update tags. The name of a domain. Type: String Default: None Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when theyaposre surrounded by letters, numbers, or other hyphens. You canapost specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode. Required: Yes</param> <param name="tagsToUpdate">A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced. Type: A complex type containing a list of tags Default: None Required: No'> Each tag includes the following elements: <ul> <li> Key The key (name) of a tag. Type: String Default: None Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@" Constraints: Each key can be 1-128 characters long. Required: Yes </li> <li> Value The value of a tag. Type: String Default: None Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@" Constraints: Each value can be 0-256 characters long. Required: Yes </li> </ul></param> <returns>The response from the UpdateTagsForDomain service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.UpdateTagsForDomain(Amazon.Route53Domains.Model.UpdateTagsForDomainRequest)"> <summary> This operation adds or updates tags for a specified domain. <para> All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateTagsForDomain service method.</param> <returns>The response from the UpdateTagsForDomain service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.IAmazonRoute53Domains.UpdateTagsForDomainAsync(Amazon.Route53Domains.Model.UpdateTagsForDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateTagsForDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTagsForDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.#ctor"> <summary> Constructs AmazonRoute53DomainsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonRoute53DomainsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.#ctor(Amazon.Route53Domains.AmazonRoute53DomainsConfig)"> <summary> Constructs AmazonRoute53DomainsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonRoute53DomainsClient Configuration Object</param> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonRoute53DomainsClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonRoute53DomainsClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.Route53Domains.AmazonRoute53DomainsConfig)"> <summary> Constructs AmazonRoute53DomainsClient with AWS Credentials and an AmazonRoute53DomainsClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonRoute53DomainsClient Configuration Object</param> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonRoute53DomainsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonRoute53DomainsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.#ctor(System.String,System.String,Amazon.Route53Domains.AmazonRoute53DomainsConfig)"> <summary> Constructs AmazonRoute53DomainsClient with AWS Access Key ID, AWS Secret Key and an AmazonRoute53DomainsClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonRoute53DomainsClient Configuration Object</param> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonRoute53DomainsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonRoute53DomainsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.#ctor(System.String,System.String,System.String,Amazon.Route53Domains.AmazonRoute53DomainsConfig)"> <summary> Constructs AmazonRoute53DomainsClient with AWS Access Key ID, AWS Secret Key and an AmazonRoute53DomainsClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonRoute53DomainsClient Configuration Object</param> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.CheckDomainAvailability(Amazon.Route53Domains.Model.CheckDomainAvailabilityRequest)"> <summary> This operation checks the availability of one domain name. You can access this API without authenticating. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name. </summary> <param name="request">Container for the necessary parameters to execute the CheckDomainAvailability service method.</param> <returns>The response from the CheckDomainAvailability service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.CheckDomainAvailabilityAsync(Amazon.Route53Domains.Model.CheckDomainAvailabilityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CheckDomainAvailability operation. </summary> <param name="request">Container for the necessary parameters to execute the CheckDomainAvailability operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.DeleteTagsForDomain(System.String,System.Collections.Generic.List{System.String})"> <summary> This operation deletes the specified tags for a domain. <para> All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. </para> </summary> <param name="domainName">The domain for which you want to delete one or more tags. The name of a domain. Type: String Default: None Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when theyaposre surrounded by letters, numbers, or other hyphens. You canapost specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode. Required: Yes</param> <param name="tagsToDelete">A list of tag keys to delete. Type: A list that contains the keys of the tags that you want to delete. Default: None Required: No'></param> <returns>The response from the DeleteTagsForDomain service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.DeleteTagsForDomain(Amazon.Route53Domains.Model.DeleteTagsForDomainRequest)"> <summary> This operation deletes the specified tags for a domain. <para> All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteTagsForDomain service method.</param> <returns>The response from the DeleteTagsForDomain service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.DeleteTagsForDomainAsync(Amazon.Route53Domains.Model.DeleteTagsForDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTagsForDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTagsForDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.DisableDomainAutoRenew(Amazon.Route53Domains.Model.DisableDomainAutoRenewRequest)"> <summary> This operation disables automatic renewal of domain registration for the specified domain. <note>Caution! Amazon Route 53 doesn't have a manual renewal process, so if you disable automatic renewal, registration for the domain will not be renewed when the expiration date passes, and you will lose control of the domain name.</note> </summary> <param name="request">Container for the necessary parameters to execute the DisableDomainAutoRenew service method.</param> <returns>The response from the DisableDomainAutoRenew service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.DisableDomainAutoRenewAsync(Amazon.Route53Domains.Model.DisableDomainAutoRenewRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableDomainAutoRenew operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableDomainAutoRenew operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.DisableDomainTransferLock(Amazon.Route53Domains.Model.DisableDomainTransferLockRequest)"> <summary> This operation removes the transfer lock on the domain (specifically the <code>clientTransferProhibited</code> status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </summary> <param name="request">Container for the necessary parameters to execute the DisableDomainTransferLock service method.</param> <returns>The response from the DisableDomainTransferLock service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.DuplicateRequestException"> The request is already in progress for the domain. </exception> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.TLDRulesViolationException"> The top-level domain does not support this operation. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.DisableDomainTransferLockAsync(Amazon.Route53Domains.Model.DisableDomainTransferLockRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableDomainTransferLock operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableDomainTransferLock operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.EnableDomainAutoRenew(Amazon.Route53Domains.Model.EnableDomainAutoRenewRequest)"> <summary> This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account. <para> The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see <a href="http://wiki.gandi.net/en/domains/renew#renewal_restoration_and_deletion_times">"Renewal, restoration, and deletion times"</a> on the website for our registrar partner, Gandi. Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline. </para> </summary> <param name="request">Container for the necessary parameters to execute the EnableDomainAutoRenew service method.</param> <returns>The response from the EnableDomainAutoRenew service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.EnableDomainAutoRenewAsync(Amazon.Route53Domains.Model.EnableDomainAutoRenewRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableDomainAutoRenew operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableDomainAutoRenew operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.EnableDomainTransferLock(Amazon.Route53Domains.Model.EnableDomainTransferLockRequest)"> <summary> This operation sets the transfer lock on the domain (specifically the <code>clientTransferProhibited</code> status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </summary> <param name="request">Container for the necessary parameters to execute the EnableDomainTransferLock service method.</param> <returns>The response from the EnableDomainTransferLock service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.DuplicateRequestException"> The request is already in progress for the domain. </exception> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.TLDRulesViolationException"> The top-level domain does not support this operation. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.EnableDomainTransferLockAsync(Amazon.Route53Domains.Model.EnableDomainTransferLockRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the EnableDomainTransferLock operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableDomainTransferLock operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.GetDomainDetail(Amazon.Route53Domains.Model.GetDomainDetailRequest)"> <summary> This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output. </summary> <param name="request">Container for the necessary parameters to execute the GetDomainDetail service method.</param> <returns>The response from the GetDomainDetail service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.GetDomainDetailAsync(Amazon.Route53Domains.Model.GetDomainDetailRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDomainDetail operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDomainDetail operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.GetOperationDetail(Amazon.Route53Domains.Model.GetOperationDetailRequest)"> <summary> This operation returns the current status of an operation that is not completed. </summary> <param name="request">Container for the necessary parameters to execute the GetOperationDetail service method.</param> <returns>The response from the GetOperationDetail service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.GetOperationDetailAsync(Amazon.Route53Domains.Model.GetOperationDetailRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetOperationDetail operation. </summary> <param name="request">Container for the necessary parameters to execute the GetOperationDetail operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.ListDomains"> <summary> This operation returns all the domain names registered with Amazon Route 53 for the current AWS account. </summary> <returns>The response from the ListDomains service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.ListDomains(Amazon.Route53Domains.Model.ListDomainsRequest)"> <summary> This operation returns all the domain names registered with Amazon Route 53 for the current AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDomains service method.</param> <returns>The response from the ListDomains service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.ListDomainsAsync(Amazon.Route53Domains.Model.ListDomainsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDomains operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDomains operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.ListOperations"> <summary> This operation returns the operation IDs of operations that are not yet complete. </summary> <returns>The response from the ListOperations service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.ListOperations(Amazon.Route53Domains.Model.ListOperationsRequest)"> <summary> This operation returns the operation IDs of operations that are not yet complete. </summary> <param name="request">Container for the necessary parameters to execute the ListOperations service method.</param> <returns>The response from the ListOperations service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.ListOperationsAsync(Amazon.Route53Domains.Model.ListOperationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListOperations operation. </summary> <param name="request">Container for the necessary parameters to execute the ListOperations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.ListTagsForDomain(System.String)"> <summary> This operation returns all of the tags that are associated with the specified domain. <para> All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. </para> </summary> <param name="domainName">The domain for which you want to get a list of tags.</param> <returns>The response from the ListTagsForDomain service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.ListTagsForDomain(Amazon.Route53Domains.Model.ListTagsForDomainRequest)"> <summary> This operation returns all of the tags that are associated with the specified domain. <para> All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForDomain service method.</param> <returns>The response from the ListTagsForDomain service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.ListTagsForDomainAsync(Amazon.Route53Domains.Model.ListTagsForDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTagsForDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.RegisterDomain(Amazon.Route53Domains.Model.RegisterDomainRequest)"> <summary> This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. For some top-level domains (TLDs), this operation requires extra parameters. <para> When you register a domain, Amazon Route 53 does the following: </para> <ul> <li>Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.</li> <li>Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.</li> <li>Optionally enables privacy protection, so WHOIS queries return contact information for our registrar partner, Gandi, instead of the information you entered for registrant, admin, and tech contacts.</li> <li>If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email.</li> <li>Charges your AWS account an amount based on the top-level domain. For more information, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the RegisterDomain service method.</param> <returns>The response from the RegisterDomain service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.DomainLimitExceededException"> The number of domains has exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.DuplicateRequestException"> The request is already in progress for the domain. </exception> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.TLDRulesViolationException"> The top-level domain does not support this operation. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.RegisterDomainAsync(Amazon.Route53Domains.Model.RegisterDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.RetrieveDomainAuthCode(Amazon.Route53Domains.Model.RetrieveDomainAuthCodeRequest)"> <summary> This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar. </summary> <param name="request">Container for the necessary parameters to execute the RetrieveDomainAuthCode service method.</param> <returns>The response from the RetrieveDomainAuthCode service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.RetrieveDomainAuthCodeAsync(Amazon.Route53Domains.Model.RetrieveDomainAuthCodeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RetrieveDomainAuthCode operation. </summary> <param name="request">Container for the necessary parameters to execute the RetrieveDomainAuthCode operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.TransferDomain(Amazon.Route53Domains.Model.TransferDomainRequest)"> <summary> This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered with the AWS registrar partner, Gandi. <para> For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-to-route-53.html">Transferring Registration for a Domain to Amazon Route 53</a> in the Amazon Route 53 Developer Guide. </para> <para> If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you consider transferring your DNS service to Amazon Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time. </para> <note>Caution! If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable.</note> <para> If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email. </para> </summary> <param name="request">Container for the necessary parameters to execute the TransferDomain service method.</param> <returns>The response from the TransferDomain service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.DomainLimitExceededException"> The number of domains has exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.DuplicateRequestException"> The request is already in progress for the domain. </exception> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.TLDRulesViolationException"> The top-level domain does not support this operation. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.TransferDomainAsync(Amazon.Route53Domains.Model.TransferDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TransferDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the TransferDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.UpdateDomainContact(Amazon.Route53Domains.Model.UpdateDomainContactRequest)"> <summary> This operation updates the contact information for a particular domain. Information for at least one contact (registrant, administrator, or technical) must be supplied for update. <para> If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateDomainContact service method.</param> <returns>The response from the UpdateDomainContact service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.DuplicateRequestException"> The request is already in progress for the domain. </exception> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.TLDRulesViolationException"> The top-level domain does not support this operation. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.UpdateDomainContactAsync(Amazon.Route53Domains.Model.UpdateDomainContactRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDomainContact operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDomainContact operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.UpdateDomainContactPrivacy(Amazon.Route53Domains.Model.UpdateDomainContactPrivacyRequest)"> <summary> This operation updates the specified domain contact's privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the <a href="http://www.gandi.net/domain/whois/?currency=USD&amp;lang=en">Gandi privacy features</a>. <para> This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateDomainContactPrivacy service method.</param> <returns>The response from the UpdateDomainContactPrivacy service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.DuplicateRequestException"> The request is already in progress for the domain. </exception> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.TLDRulesViolationException"> The top-level domain does not support this operation. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.UpdateDomainContactPrivacyAsync(Amazon.Route53Domains.Model.UpdateDomainContactPrivacyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDomainContactPrivacy operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDomainContactPrivacy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.UpdateDomainNameservers(Amazon.Route53Domains.Model.UpdateDomainNameserversRequest)"> <summary> This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain. <para> If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateDomainNameservers service method.</param> <returns>The response from the UpdateDomainNameservers service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.DuplicateRequestException"> The request is already in progress for the domain. </exception> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.TLDRulesViolationException"> The top-level domain does not support this operation. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.UpdateDomainNameserversAsync(Amazon.Route53Domains.Model.UpdateDomainNameserversRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateDomainNameservers operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDomainNameservers operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.UpdateTagsForDomain(System.String,System.Collections.Generic.List{Amazon.Route53Domains.Model.Tag})"> <summary> This operation adds or updates tags for a specified domain. <para> All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. </para> </summary> <param name="domainName">The domain for which you want to add or update tags. The name of a domain. Type: String Default: None Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when theyaposre surrounded by letters, numbers, or other hyphens. You canapost specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode. Required: Yes</param> <param name="tagsToUpdate">A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced. Type: A complex type containing a list of tags Default: None Required: No'> Each tag includes the following elements: <ul> <li> Key The key (name) of a tag. Type: String Default: None Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@" Constraints: Each key can be 1-128 characters long. Required: Yes </li> <li> Value The value of a tag. Type: String Default: None Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@" Constraints: Each value can be 0-256 characters long. Required: Yes </li> </ul></param> <returns>The response from the UpdateTagsForDomain service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.UpdateTagsForDomain(Amazon.Route53Domains.Model.UpdateTagsForDomainRequest)"> <summary> This operation adds or updates tags for a specified domain. <para> All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateTagsForDomain service method.</param> <returns>The response from the UpdateTagsForDomain service method, as returned by Route53Domains.</returns> <exception cref="T:Amazon.Route53Domains.Model.InvalidInputException"> The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account. </exception> <exception cref="T:Amazon.Route53Domains.Model.OperationLimitExceededException"> The number of operations or jobs running exceeded the allowed threshold for the account. </exception> <exception cref="T:Amazon.Route53Domains.Model.UnsupportedTLDException"> Amazon Route 53 does not support this top-level domain. </exception> </member> <member name="M:Amazon.Route53Domains.AmazonRoute53DomainsClient.UpdateTagsForDomainAsync(Amazon.Route53Domains.Model.UpdateTagsForDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateTagsForDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTagsForDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.Runtime.HttpRequestMessageFactory"> <summary> A factory which creates HTTP requests which uses System.Net.Http.HttpClient. </summary> </member> <member name="M:Amazon.Runtime.HttpRequestMessageFactory.#ctor(Amazon.Runtime.ClientConfig)"> <summary> The constructor for HttpRequestMessageFactory. </summary> <param name="clientConfig">Configuration setting for a client.</param> </member> <member name="M:Amazon.Runtime.HttpRequestMessageFactory.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.HttpRequestMessageFactory.Dispose"> <summary> Disposes the HttpRequestMessageFactory. </summary> </member> <member name="T:Amazon.Runtime.HttpWebRequestMessage"> <summary> HTTP request wrapper for System.Net.Http.HttpRequestMessage. </summary> </member> <member name="F:Amazon.Runtime.HttpWebRequestMessage.ContentHeaderNames"> <summary> Set of content header names. </summary> </member> <member name="M:Amazon.Runtime.HttpWebRequestMessage.#ctor(System.Uri,Amazon.Runtime.ClientConfig)"> <summary> The constructor for HttpWebRequestMessage. </summary> <param name="requestUri">The request URI.</param> <param name="config">The service client config.</param> </member> <member name="M:Amazon.Runtime.HttpWebRequestMessage.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.HttpWebRequestMessage.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.HttpWebRequestMessage.GetRequestContent"> <summary> Gets a handle to the request content. </summary> <returns>The request content.</returns> </member> <member name="M:Amazon.Runtime.HttpWebRequestMessage.GetResponse"> <summary> Returns the HTTP response. </summary> <returns>The HTTP response.</returns> </member> <member name="M:Amazon.Runtime.HttpWebRequestMessage.Abort"> <summary> Aborts the HTTP request. </summary> </member> <member name="M:Amazon.Runtime.HttpWebRequestMessage.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.HttpWebRequestMessage.WriteToRequestBody(System.Net.Http.HttpContent,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.HttpWebRequestMessage.WriteToRequestBody(System.Net.Http.HttpContent,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.HttpWebRequestMessage.GetRequestContentAsync"> <summary> Gets a handle to the request content. </summary> <returns></returns> </member> <member name="M:Amazon.Runtime.HttpWebRequestMessage.Dispose"> <summary> Disposes the HttpWebRequestMessage. </summary> </member> <member name="P:Amazon.Runtime.HttpWebRequestMessage.Request"> <summary> The underlying HTTP web request. </summary> </member> <member name="P:Amazon.Runtime.HttpWebRequestMessage.Method"> <summary> The HTTP method or verb. </summary> </member> <member name="P:Amazon.Runtime.HttpWebRequestMessage.RequestUri"> <summary> The request URI. </summary> </member> <member name="T:Amazon.S3.AmazonS3Client"> <summary> Implementation for accessing S3 </summary> </member> <member name="T:Amazon.S3.IAmazonS3"> <summary> Interface for accessing S3 </summary> <summary> Interface for Amazon S3 Clients. For more information about Amazon S3, go to <see href="http://aws.amazon.com/s3"/> </summary> </member> <member name="M:Amazon.S3.IAmazonS3.AbortMultipartUpload(System.String,System.String,System.String)"> <summary> Aborts a multipart upload. <para> To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty. </para> </summary> <param name="bucketName">A property of AbortMultipartUploadRequest used to execute the AbortMultipartUpload service method.</param> <param name="key">A property of AbortMultipartUploadRequest used to execute the AbortMultipartUpload service method.</param> <param name="uploadId">A property of AbortMultipartUploadRequest used to execute the AbortMultipartUpload service method.</param> <returns>The response from the AbortMultipartUpload service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.AbortMultipartUpload(Amazon.S3.Model.AbortMultipartUploadRequest)"> <summary> Aborts a multipart upload. <para> To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty. </para> </summary> <param name="request">Container for the necessary parameters to execute the AbortMultipartUpload service method.</param> <returns>The response from the AbortMultipartUpload service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.AbortMultipartUploadAsync(Amazon.S3.Model.AbortMultipartUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AbortMultipartUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the AbortMultipartUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.CompleteMultipartUpload(Amazon.S3.Model.CompleteMultipartUploadRequest)"> <summary> Completes a multipart upload by assembling previously uploaded parts. </summary> <param name="request">Container for the necessary parameters to execute the CompleteMultipartUpload service method.</param> <returns>The response from the CompleteMultipartUpload service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.CompleteMultipartUploadAsync(Amazon.S3.Model.CompleteMultipartUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CompleteMultipartUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the CompleteMultipartUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.CopyObject(System.String,System.String,System.String,System.String)"> <summary> Creates a copy of an object that is already stored in Amazon S3. </summary> <param name="sourceBucket">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <param name="sourceKey">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <param name="destinationBucket">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <param name="destinationKey">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <returns>The response from the CopyObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.CopyObject(System.String,System.String,System.String,System.String,System.String)"> <summary> Creates a copy of an object that is already stored in Amazon S3. </summary> <param name="sourceBucket">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <param name="sourceKey">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <param name="sourceVersionId">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <param name="destinationBucket">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <param name="destinationKey">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <returns>The response from the CopyObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.CopyObject(Amazon.S3.Model.CopyObjectRequest)"> <summary> Creates a copy of an object that is already stored in Amazon S3. </summary> <param name="request">Container for the necessary parameters to execute the CopyObject service method.</param> <returns>The response from the CopyObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.CopyObjectAsync(Amazon.S3.Model.CopyObjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopyObject operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyObject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.CopyPart(System.String,System.String,System.String,System.String,System.String)"> <summary> Uploads a part by copying data from an existing object as data source. </summary> <param name="sourceBucket">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="sourceKey">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="destinationBucket">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="destinationKey">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="uploadId">Upload ID identifying the multipart upload whose part is being copied.</param> <returns>The response from the CopyPart service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.CopyPart(System.String,System.String,System.String,System.String,System.String,System.String)"> <summary> Uploads a part by copying data from an existing object as data source. </summary> <param name="sourceBucket">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="sourceKey">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="sourceVersionId">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="destinationBucket">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="destinationKey">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="uploadId">Upload ID identifying the multipart upload whose part is being copied.</param> <returns>The response from the CopyPart service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.CopyPart(Amazon.S3.Model.CopyPartRequest)"> <summary> Uploads a part by copying data from an existing object as data source. </summary> <param name="request">Container for the necessary parameters to execute the CopyPart service method.</param> <returns>The response from the CopyPart service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.CopyPartAsync(Amazon.S3.Model.CopyPartRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopyPart operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyPart operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteBucket(System.String)"> <summary> Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted. </summary> <param name="bucketName">A property of DeleteBucketRequest used to execute the DeleteBucket service method.</param> <returns>The response from the DeleteBucket service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteBucket(Amazon.S3.Model.DeleteBucketRequest)"> <summary> Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucket service method.</param> <returns>The response from the DeleteBucket service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteBucketAsync(Amazon.S3.Model.DeleteBucketRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteBucket operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucket operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteBucketPolicy(System.String)"> <summary> Deletes the policy from the bucket. </summary> <param name="bucketName">A property of DeleteBucketPolicyRequest used to execute the DeleteBucketPolicy service method.</param> <returns>The response from the DeleteBucketPolicy service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteBucketPolicy(Amazon.S3.Model.DeleteBucketPolicyRequest)"> <summary> Deletes the policy from the bucket. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucketPolicy service method.</param> <returns>The response from the DeleteBucketPolicy service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteBucketPolicyAsync(Amazon.S3.Model.DeleteBucketPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteBucketPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucketPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteBucketReplication(Amazon.S3.Model.DeleteBucketReplicationRequest)"> <summary> Deletes the replication configuration for the given Amazon S3 bucket. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucketReplication service method.</param> <returns>The response from the DeleteBucketReplication service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteBucketReplicationAsync(Amazon.S3.Model.DeleteBucketReplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteBucketReplication operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucketReplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteBucketTagging(System.String)"> <summary> Deletes the tags from the bucket. </summary> <param name="bucketName">A property of DeleteBucketTaggingRequest used to execute the DeleteBucketTagging service method.</param> <returns>The response from the DeleteBucketTagging service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteBucketTagging(Amazon.S3.Model.DeleteBucketTaggingRequest)"> <summary> Deletes the tags from the bucket. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucketTagging service method.</param> <returns>The response from the DeleteBucketTagging service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteBucketTaggingAsync(Amazon.S3.Model.DeleteBucketTaggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteBucketTagging operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucketTagging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteBucketWebsite(System.String)"> <summary> This operation removes the website configuration from the bucket. </summary> <param name="bucketName">A property of DeleteBucketWebsiteRequest used to execute the DeleteBucketWebsite service method.</param> <returns>The response from the DeleteBucketWebsite service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteBucketWebsite(Amazon.S3.Model.DeleteBucketWebsiteRequest)"> <summary> This operation removes the website configuration from the bucket. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucketWebsite service method.</param> <returns>The response from the DeleteBucketWebsite service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteBucketWebsiteAsync(Amazon.S3.Model.DeleteBucketWebsiteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteBucketWebsite operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucketWebsite operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteCORSConfiguration(System.String)"> <summary> Deletes the cors configuration information set for the bucket. </summary> <param name="bucketName">A property of DeleteCORSConfigurationRequest used to execute the DeleteCORSConfiguration service method.</param> <returns>The response from the DeleteCORSConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteCORSConfiguration(Amazon.S3.Model.DeleteCORSConfigurationRequest)"> <summary> Deletes the cors configuration information set for the bucket. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCORSConfiguration service method.</param> <returns>The response from the DeleteCORSConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteCORSConfigurationAsync(Amazon.S3.Model.DeleteCORSConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCORSConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCORSConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteLifecycleConfiguration(System.String)"> <summary> Deletes the lifecycle configuration from the bucket. </summary> <param name="bucketName">A property of DeleteLifecycleConfigurationRequest used to execute the DeleteLifecycleConfiguration service method.</param> <returns>The response from the DeleteLifecycleConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteLifecycleConfiguration(Amazon.S3.Model.DeleteLifecycleConfigurationRequest)"> <summary> Deletes the lifecycle configuration from the bucket. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method.</param> <returns>The response from the DeleteLifecycleConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteLifecycleConfigurationAsync(Amazon.S3.Model.DeleteLifecycleConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLifecycleConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLifecycleConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteObject(System.String,System.String)"> <summary> Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects. </summary> <param name="bucketName">A property of DeleteObjectRequest used to execute the DeleteObject service method.</param> <param name="key">A property of DeleteObjectRequest used to execute the DeleteObject service method.</param> <returns>The response from the DeleteObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteObject(System.String,System.String,System.String)"> <summary> Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects. </summary> <param name="bucketName">A property of DeleteObjectRequest used to execute the DeleteObject service method.</param> <param name="key">A property of DeleteObjectRequest used to execute the DeleteObject service method.</param> <param name="versionId">VersionId used to reference a specific version of the object.</param> <returns>The response from the DeleteObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteObject(Amazon.S3.Model.DeleteObjectRequest)"> <summary> Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects. </summary> <param name="request">Container for the necessary parameters to execute the DeleteObject service method.</param> <returns>The response from the DeleteObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteObjectAsync(Amazon.S3.Model.DeleteObjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteObject operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteObject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteObjects(Amazon.S3.Model.DeleteObjectsRequest)"> <summary> This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys. </summary> <param name="request">Container for the necessary parameters to execute the DeleteObjects service method.</param> <returns>The response from the DeleteObjects service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.DeleteObjectsAsync(Amazon.S3.Model.DeleteObjectsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteObjects operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteObjects operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetACL(System.String)"> <summary> Gets the access control policy for the bucket. </summary> <param name="bucketName">A property of GetACLRequest used to execute the GetACL service method.</param> <returns>The response from the GetACL service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetACL(Amazon.S3.Model.GetACLRequest)"> <summary> Gets the access control policy for the bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetACL service method.</param> <returns>The response from the GetACL service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetACLAsync(Amazon.S3.Model.GetACLRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetACL operation. </summary> <param name="request">Container for the necessary parameters to execute the GetACL operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketLocation(System.String)"> <summary> Returns the region the bucket resides in. </summary> <param name="bucketName">A property of GetBucketLocationRequest used to execute the GetBucketLocation service method.</param> <returns>The response from the GetBucketLocation service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketLocation(Amazon.S3.Model.GetBucketLocationRequest)"> <summary> Returns the region the bucket resides in. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketLocation service method.</param> <returns>The response from the GetBucketLocation service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketLocationAsync(Amazon.S3.Model.GetBucketLocationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketLocation operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketLocation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketLogging(System.String)"> <summary> Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner. </summary> <param name="bucketName">A property of GetBucketLoggingRequest used to execute the GetBucketLogging service method.</param> <returns>The response from the GetBucketLogging service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketLogging(Amazon.S3.Model.GetBucketLoggingRequest)"> <summary> Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketLogging service method.</param> <returns>The response from the GetBucketLogging service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketLoggingAsync(Amazon.S3.Model.GetBucketLoggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketLogging operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketLogging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketNotification(System.String)"> <summary> Returns the notification configuration of a bucket. </summary> <param name="bucketName">Name of the bucket to get the notification configuration for.</param> <returns>The response from the GetBucketNotification service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketNotification(Amazon.S3.Model.GetBucketNotificationRequest)"> <summary> Returns the notification configuration of a bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketNotification service method.</param> <returns>The response from the GetBucketNotification service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketNotificationAsync(Amazon.S3.Model.GetBucketNotificationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketNotification operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketNotification operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketPolicy(System.String)"> <summary> Returns the policy of a specified bucket. </summary> <param name="bucketName">A property of GetBucketPolicyRequest used to execute the GetBucketPolicy service method.</param> <returns>The response from the GetBucketPolicy service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketPolicy(Amazon.S3.Model.GetBucketPolicyRequest)"> <summary> Returns the policy of a specified bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketPolicy service method.</param> <returns>The response from the GetBucketPolicy service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketPolicyAsync(Amazon.S3.Model.GetBucketPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketReplication(Amazon.S3.Model.GetBucketReplicationRequest)"> <summary> Retrieves the replication configuration for the given Amazon S3 bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketReplication service method.</param> <returns>The response from the GetBucketReplication service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketReplicationAsync(Amazon.S3.Model.GetBucketReplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketReplication operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketReplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketRequestPayment(System.String)"> <summary> Returns the request payment configuration of a bucket. </summary> <param name="bucketName">A property of GetBucketRequestPaymentRequest used to execute the GetBucketRequestPayment service method.</param> <returns>The response from the GetBucketRequestPayment service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketRequestPayment(Amazon.S3.Model.GetBucketRequestPaymentRequest)"> <summary> Returns the request payment configuration of a bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketRequestPayment service method.</param> <returns>The response from the GetBucketRequestPayment service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketRequestPaymentAsync(Amazon.S3.Model.GetBucketRequestPaymentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketRequestPayment operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketRequestPayment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketTagging(Amazon.S3.Model.GetBucketTaggingRequest)"> <summary> Returns the tag set associated with the bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketTagging service method.</param> <returns>The response from the GetBucketTagging service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketTaggingAsync(Amazon.S3.Model.GetBucketTaggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketTagging operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketTagging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketVersioning(System.String)"> <summary> Returns the versioning state of a bucket. </summary> <param name="bucketName">A property of GetBucketVersioningRequest used to execute the GetBucketVersioning service method.</param> <returns>The response from the GetBucketVersioning service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketVersioning(Amazon.S3.Model.GetBucketVersioningRequest)"> <summary> Returns the versioning state of a bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketVersioning service method.</param> <returns>The response from the GetBucketVersioning service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketVersioningAsync(Amazon.S3.Model.GetBucketVersioningRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketVersioning operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketVersioning operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketWebsite(System.String)"> <summary> Returns the website configuration for a bucket. </summary> <param name="bucketName">A property of GetBucketWebsiteRequest used to execute the GetBucketWebsite service method.</param> <returns>The response from the GetBucketWebsite service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketWebsite(Amazon.S3.Model.GetBucketWebsiteRequest)"> <summary> Returns the website configuration for a bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketWebsite service method.</param> <returns>The response from the GetBucketWebsite service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetBucketWebsiteAsync(Amazon.S3.Model.GetBucketWebsiteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketWebsite operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketWebsite operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetCORSConfiguration(System.String)"> <summary> Returns the cors configuration for the bucket. </summary> <param name="bucketName">A property of GetCORSConfigurationRequest used to execute the GetCORSConfiguration service method.</param> <returns>The response from the GetCORSConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetCORSConfiguration(Amazon.S3.Model.GetCORSConfigurationRequest)"> <summary> Returns the cors configuration for the bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetCORSConfiguration service method.</param> <returns>The response from the GetCORSConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetCORSConfigurationAsync(Amazon.S3.Model.GetCORSConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetCORSConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCORSConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetLifecycleConfiguration(System.String)"> <summary> Returns the lifecycle configuration information set on the bucket. </summary> <param name="bucketName">A property of GetLifecycleConfigurationRequest used to execute the GetLifecycleConfiguration service method.</param> <returns>The response from the GetLifecycleConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetLifecycleConfiguration(Amazon.S3.Model.GetLifecycleConfigurationRequest)"> <summary> Returns the lifecycle configuration information set on the bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetLifecycleConfiguration service method.</param> <returns>The response from the GetLifecycleConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetLifecycleConfigurationAsync(Amazon.S3.Model.GetLifecycleConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetLifecycleConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the GetLifecycleConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetObject(System.String,System.String)"> <summary> Retrieves objects from Amazon S3. </summary> <param name="bucketName">A property of GetObjectRequest used to execute the GetObject service method.</param> <param name="key">A property of GetObjectRequest used to execute the GetObject service method.</param> <returns>The response from the GetObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetObject(System.String,System.String,System.String)"> <summary> Retrieves objects from Amazon S3. </summary> <param name="bucketName">A property of GetObjectRequest used to execute the GetObject service method.</param> <param name="key">A property of GetObjectRequest used to execute the GetObject service method.</param> <param name="versionId">VersionId used to reference a specific version of the object.</param> <returns>The response from the GetObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetObject(Amazon.S3.Model.GetObjectRequest)"> <summary> Retrieves objects from Amazon S3. </summary> <param name="request">Container for the necessary parameters to execute the GetObject service method.</param> <returns>The response from the GetObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetObjectAsync(Amazon.S3.Model.GetObjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetObject operation. </summary> <param name="request">Container for the necessary parameters to execute the GetObject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetObjectMetadata(System.String,System.String)"> <summary> The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. </summary> <param name="bucketName">A property of GetObjectMetadataRequest used to execute the GetObjectMetadata service method.</param> <param name="key">A property of GetObjectMetadataRequest used to execute the GetObjectMetadata service method.</param> <returns>The response from the GetObjectMetadata service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetObjectMetadata(System.String,System.String,System.String)"> <summary> The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. </summary> <param name="bucketName">A property of GetObjectMetadataRequest used to execute the GetObjectMetadata service method.</param> <param name="key">A property of GetObjectMetadataRequest used to execute the GetObjectMetadata service method.</param> <param name="versionId">VersionId used to reference a specific version of the object.</param> <returns>The response from the GetObjectMetadata service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetObjectMetadata(Amazon.S3.Model.GetObjectMetadataRequest)"> <summary> The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. </summary> <param name="request">Container for the necessary parameters to execute the GetObjectMetadata service method.</param> <returns>The response from the GetObjectMetadata service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetObjectMetadataAsync(Amazon.S3.Model.GetObjectMetadataRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetObjectMetadata operation. </summary> <param name="request">Container for the necessary parameters to execute the GetObjectMetadata operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetObjectTorrent(System.String,System.String)"> <summary> Return torrent files from a bucket. </summary> <param name="bucketName">A property of GetObjectTorrentRequest used to execute the GetObjectTorrent service method.</param> <param name="key">A property of GetObjectTorrentRequest used to execute the GetObjectTorrent service method.</param> <returns>The response from the GetObjectTorrent service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetObjectTorrent(Amazon.S3.Model.GetObjectTorrentRequest)"> <summary> Return torrent files from a bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetObjectTorrent service method.</param> <returns>The response from the GetObjectTorrent service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetObjectTorrentAsync(Amazon.S3.Model.GetObjectTorrentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetObjectTorrent operation. </summary> <param name="request">Container for the necessary parameters to execute the GetObjectTorrent operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.InitiateMultipartUpload(System.String,System.String)"> <summary> Initiates a multipart upload and returns an upload ID. <para> <b>Note:</b> After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. </para> </summary> <param name="bucketName">A property of InitiateMultipartUploadRequest used to execute the InitiateMultipartUpload service method.</param> <param name="key">A property of InitiateMultipartUploadRequest used to execute the InitiateMultipartUpload service method.</param> <returns>The response from the InitiateMultipartUpload service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.InitiateMultipartUpload(Amazon.S3.Model.InitiateMultipartUploadRequest)"> <summary> Initiates a multipart upload and returns an upload ID. <para> <b>Note:</b> After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. </para> </summary> <param name="request">Container for the necessary parameters to execute the InitiateMultipartUpload service method.</param> <returns>The response from the InitiateMultipartUpload service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.InitiateMultipartUploadAsync(Amazon.S3.Model.InitiateMultipartUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the InitiateMultipartUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the InitiateMultipartUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListBuckets"> <summary> Returns a list of all buckets owned by the authenticated sender of the request. </summary> <returns>The response from the ListBuckets service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListBuckets(Amazon.S3.Model.ListBucketsRequest)"> <summary> Returns a list of all buckets owned by the authenticated sender of the request. </summary> <param name="request">Container for the necessary parameters to execute the ListBuckets service method.</param> <returns>The response from the ListBuckets service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListBucketsAsync(Amazon.S3.Model.ListBucketsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListBuckets operation. </summary> <param name="request">Container for the necessary parameters to execute the ListBuckets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListMultipartUploads(System.String)"> <summary> This operation lists in-progress multipart uploads. </summary> <param name="bucketName">A property of ListMultipartUploadsRequest used to execute the ListMultipartUploads service method.</param> <returns>The response from the ListMultipartUploads service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListMultipartUploads(System.String,System.String)"> <summary> This operation lists in-progress multipart uploads. </summary> <param name="bucketName">A property of ListMultipartUploadsRequest used to execute the ListMultipartUploads service method.</param> <param name="prefix">Lists in-progress uploads only for those keys that begin with the specified prefix.</param> <returns>The response from the ListMultipartUploads service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListMultipartUploads(Amazon.S3.Model.ListMultipartUploadsRequest)"> <summary> This operation lists in-progress multipart uploads. </summary> <param name="request">Container for the necessary parameters to execute the ListMultipartUploads service method.</param> <returns>The response from the ListMultipartUploads service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListMultipartUploadsAsync(Amazon.S3.Model.ListMultipartUploadsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListMultipartUploads operation. </summary> <param name="request">Container for the necessary parameters to execute the ListMultipartUploads operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListObjects(System.String)"> <summary> Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. </summary> <param name="bucketName">A property of ListObjectsRequest used to execute the ListObjects service method.</param> <returns>The response from the ListObjects service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListObjects(System.String,System.String)"> <summary> Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. </summary> <param name="bucketName">A property of ListObjectsRequest used to execute the ListObjects service method.</param> <param name="prefix">Limits the response to keys that begin with the specified prefix.</param> <returns>The response from the ListObjects service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListObjects(Amazon.S3.Model.ListObjectsRequest)"> <summary> Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. </summary> <param name="request">Container for the necessary parameters to execute the ListObjects service method.</param> <returns>The response from the ListObjects service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListObjectsAsync(Amazon.S3.Model.ListObjectsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListObjects operation. </summary> <param name="request">Container for the necessary parameters to execute the ListObjects operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListParts(System.String,System.String,System.String)"> <summary> Lists the parts that have been uploaded for a specific multipart upload. </summary> <param name="bucketName">A property of ListPartsRequest used to execute the ListParts service method.</param> <param name="key">A property of ListPartsRequest used to execute the ListParts service method.</param> <param name="uploadId">Upload ID identifying the multipart upload whose parts are being listed.</param> <returns>The response from the ListParts service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListParts(Amazon.S3.Model.ListPartsRequest)"> <summary> Lists the parts that have been uploaded for a specific multipart upload. </summary> <param name="request">Container for the necessary parameters to execute the ListParts service method.</param> <returns>The response from the ListParts service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListPartsAsync(Amazon.S3.Model.ListPartsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListParts operation. </summary> <param name="request">Container for the necessary parameters to execute the ListParts operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListVersions(System.String)"> <summary> Returns metadata about all of the versions of objects in a bucket. </summary> <param name="bucketName">A property of ListVersionsRequest used to execute the ListVersions service method.</param> <returns>The response from the ListVersions service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListVersions(System.String,System.String)"> <summary> Returns metadata about all of the versions of objects in a bucket. </summary> <param name="bucketName">A property of ListVersionsRequest used to execute the ListVersions service method.</param> <param name="prefix">Limits the response to keys that begin with the specified prefix.</param> <returns>The response from the ListVersions service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListVersions(Amazon.S3.Model.ListVersionsRequest)"> <summary> Returns metadata about all of the versions of objects in a bucket. </summary> <param name="request">Container for the necessary parameters to execute the ListVersions service method.</param> <returns>The response from the ListVersions service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.ListVersionsAsync(Amazon.S3.Model.ListVersionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListVersions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListVersions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutACL(Amazon.S3.Model.PutACLRequest)"> <summary> Sets the permissions on a bucket using access control lists (ACL). </summary> <param name="request">Container for the necessary parameters to execute the PutACL service method.</param> <returns>The response from the PutACL service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutACLAsync(Amazon.S3.Model.PutACLRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutACL operation. </summary> <param name="request">Container for the necessary parameters to execute the PutACL operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucket(System.String)"> <summary> Creates a new bucket. </summary> <param name="bucketName">A property of PutBucketRequest used to execute the PutBucket service method.</param> <returns>The response from the PutBucket service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucket(Amazon.S3.Model.PutBucketRequest)"> <summary> Creates a new bucket. </summary> <param name="request">Container for the necessary parameters to execute the PutBucket service method.</param> <returns>The response from the PutBucket service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketAsync(Amazon.S3.Model.PutBucketRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucket operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucket operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketLogging(Amazon.S3.Model.PutBucketLoggingRequest)"> <summary> Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketLogging service method.</param> <returns>The response from the PutBucketLogging service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketLoggingAsync(Amazon.S3.Model.PutBucketLoggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucketLogging operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketLogging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketNotification(Amazon.S3.Model.PutBucketNotificationRequest)"> <summary> Enables notifications of specified events for a bucket. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketNotification service method.</param> <returns>The response from the PutBucketNotification service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketNotificationAsync(Amazon.S3.Model.PutBucketNotificationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucketNotification operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketNotification operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketPolicy(System.String,System.String)"> <summary> Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. </summary> <param name="bucketName">A property of PutBucketPolicyRequest used to execute the PutBucketPolicy service method.</param> <param name="policy">The bucket policy as a JSON document.</param> <returns>The response from the PutBucketPolicy service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketPolicy(System.String,System.String,System.String)"> <summary> Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. </summary> <param name="bucketName">A property of PutBucketPolicyRequest used to execute the PutBucketPolicy service method.</param> <param name="policy">The bucket policy as a JSON document.</param> <param name="contentMD5">A property of PutBucketPolicyRequest used to execute the PutBucketPolicy service method.</param> <returns>The response from the PutBucketPolicy service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketPolicy(Amazon.S3.Model.PutBucketPolicyRequest)"> <summary> Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketPolicy service method.</param> <returns>The response from the PutBucketPolicy service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketPolicyAsync(Amazon.S3.Model.PutBucketPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucketPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketReplication(Amazon.S3.Model.PutBucketReplicationRequest)"> <summary> Creates a new replication configuration (or replaces an existing one, if present). </summary> <param name="request">Container for the necessary parameters to execute the PutBucketReplication service method.</param> <returns>The response from the PutBucketReplication service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketReplicationAsync(Amazon.S3.Model.PutBucketReplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucketReplication operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketReplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketRequestPayment(System.String,Amazon.S3.Model.RequestPaymentConfiguration)"> <summary> Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html </summary> <param name="bucketName">A property of PutBucketRequestPaymentRequest used to execute the PutBucketRequestPayment service method.</param> <param name="requestPaymentConfiguration">A property of PutBucketRequestPaymentRequest used to execute the PutBucketRequestPayment service method.</param> <returns>The response from the PutBucketRequestPayment service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketRequestPayment(Amazon.S3.Model.PutBucketRequestPaymentRequest)"> <summary> Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html </summary> <param name="request">Container for the necessary parameters to execute the PutBucketRequestPayment service method.</param> <returns>The response from the PutBucketRequestPayment service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketRequestPaymentAsync(Amazon.S3.Model.PutBucketRequestPaymentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucketRequestPayment operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketRequestPayment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketTagging(System.String,System.Collections.Generic.List{Amazon.S3.Model.Tag})"> <summary> Sets the tags for a bucket. </summary> <param name="bucketName">A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method.</param> <param name="tagSet">A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method.</param> <returns>The response from the PutBucketTagging service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketTagging(Amazon.S3.Model.PutBucketTaggingRequest)"> <summary> Sets the tags for a bucket. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketTagging service method.</param> <returns>The response from the PutBucketTagging service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketTaggingAsync(Amazon.S3.Model.PutBucketTaggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucketTagging operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketTagging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketVersioning(Amazon.S3.Model.PutBucketVersioningRequest)"> <summary> Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketVersioning service method.</param> <returns>The response from the PutBucketVersioning service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketVersioningAsync(Amazon.S3.Model.PutBucketVersioningRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucketVersioning operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketVersioning operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketWebsite(System.String,Amazon.S3.Model.WebsiteConfiguration)"> <summary> Set the website configuration for a bucket. </summary> <param name="bucketName">A property of PutBucketWebsiteRequest used to execute the PutBucketWebsite service method.</param> <param name="websiteConfiguration">A property of PutBucketWebsiteRequest used to execute the PutBucketWebsite service method.</param> <returns>The response from the PutBucketWebsite service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketWebsite(Amazon.S3.Model.PutBucketWebsiteRequest)"> <summary> Set the website configuration for a bucket. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketWebsite service method.</param> <returns>The response from the PutBucketWebsite service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutBucketWebsiteAsync(Amazon.S3.Model.PutBucketWebsiteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucketWebsite operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketWebsite operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutCORSConfiguration(System.String,Amazon.S3.Model.CORSConfiguration)"> <summary> Sets the cors configuration for a bucket. </summary> <param name="bucketName">A property of PutCORSConfigurationRequest used to execute the PutCORSConfiguration service method.</param> <param name="configuration">A property of PutCORSConfigurationRequest used to execute the PutCORSConfiguration service method.</param> <returns>The response from the PutCORSConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutCORSConfiguration(Amazon.S3.Model.PutCORSConfigurationRequest)"> <summary> Sets the cors configuration for a bucket. </summary> <param name="request">Container for the necessary parameters to execute the PutCORSConfiguration service method.</param> <returns>The response from the PutCORSConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutCORSConfigurationAsync(Amazon.S3.Model.PutCORSConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutCORSConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the PutCORSConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutLifecycleConfiguration(System.String,Amazon.S3.Model.LifecycleConfiguration)"> <summary> Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. </summary> <param name="bucketName">A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method.</param> <param name="configuration">A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method.</param> <returns>The response from the PutLifecycleConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutLifecycleConfiguration(Amazon.S3.Model.PutLifecycleConfigurationRequest)"> <summary> Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. </summary> <param name="request">Container for the necessary parameters to execute the PutLifecycleConfiguration service method.</param> <returns>The response from the PutLifecycleConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutLifecycleConfigurationAsync(Amazon.S3.Model.PutLifecycleConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutLifecycleConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the PutLifecycleConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutObject(Amazon.S3.Model.PutObjectRequest)"> <summary> Adds an object to a bucket. </summary> <param name="request">Container for the necessary parameters to execute the PutObject service method.</param> <returns>The response from the PutObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.PutObjectAsync(Amazon.S3.Model.PutObjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutObject operation. </summary> <param name="request">Container for the necessary parameters to execute the PutObject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.RestoreObject(System.String,System.String)"> <summary> Restores an archived copy of an object back into Amazon S3 </summary> <param name="bucketName">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <param name="key">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <returns>The response from the RestoreObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.RestoreObject(System.String,System.String,System.Int32)"> <summary> Restores an archived copy of an object back into Amazon S3 </summary> <param name="bucketName">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <param name="key">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <param name="days">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <returns>The response from the RestoreObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.RestoreObject(System.String,System.String,System.String)"> <summary> Restores an archived copy of an object back into Amazon S3 </summary> <param name="bucketName">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <param name="key">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <param name="versionId">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <returns>The response from the RestoreObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.RestoreObject(System.String,System.String,System.String,System.Int32)"> <summary> Restores an archived copy of an object back into Amazon S3 </summary> <param name="bucketName">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <param name="key">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <param name="versionId">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <param name="days">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <returns>The response from the RestoreObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.RestoreObject(Amazon.S3.Model.RestoreObjectRequest)"> <summary> Restores an archived copy of an object back into Amazon S3 </summary> <param name="request">Container for the necessary parameters to execute the RestoreObject service method.</param> <returns>The response from the RestoreObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.RestoreObjectAsync(Amazon.S3.Model.RestoreObjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestoreObject operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreObject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.UploadPart(Amazon.S3.Model.UploadPartRequest)"> <summary> Uploads a part in a multipart upload. <para> <b>Note:</b> After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. </para> </summary> <param name="request">Container for the necessary parameters to execute the UploadPart service method.</param> <returns>The response from the UploadPart service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.UploadPartAsync(Amazon.S3.Model.UploadPartRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UploadPart operation. </summary> <param name="request">Container for the necessary parameters to execute the UploadPart operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.IAmazonS3.GetPreSignedURL(Amazon.S3.Model.GetPreSignedUrlRequest)"> <summary> Create a signed URL allowing access to a resource that would usually require authentication. </summary> <remarks> <para> When using query string authentication you create a query, specify an expiration time for the query, sign it with your signature, place the data in an HTTP request, and distribute the request to a user or embed the request in a web page. </para> <para> A PreSigned URL can be generated for GET, PUT, DELETE and HEAD operations on your bucketName, keys, and versions. </para> </remarks> <param name="request">The GetPreSignedUrlRequest that defines the parameters of the operation.</param> <returns>A string that is the signed http request.</returns> <exception cref="T:System.ArgumentException" /> <exception cref="T:System.ArgumentNullException" /> </member> <member name="M:Amazon.S3.AmazonS3Client.#ctor"> <summary> Constructs AmazonS3Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.S3.AmazonS3Client.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonS3Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.S3.AmazonS3Client.#ctor(Amazon.S3.AmazonS3Config)"> <summary> Constructs AmazonS3Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonS3Client Configuration Object</param> </member> <member name="M:Amazon.S3.AmazonS3Client.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonS3Client with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.S3.AmazonS3Client.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonS3Client with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.S3.AmazonS3Client.#ctor(Amazon.Runtime.AWSCredentials,Amazon.S3.AmazonS3Config)"> <summary> Constructs AmazonS3Client with AWS Credentials and an AmazonS3Client Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonS3Client Configuration Object</param> </member> <member name="M:Amazon.S3.AmazonS3Client.#ctor(System.String,System.String)"> <summary> Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.S3.AmazonS3Client.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.S3.AmazonS3Client.#ctor(System.String,System.String,Amazon.S3.AmazonS3Config)"> <summary> Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an AmazonS3Client Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonS3Client Configuration Object</param> </member> <member name="M:Amazon.S3.AmazonS3Client.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.S3.AmazonS3Client.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.S3.AmazonS3Client.#ctor(System.String,System.String,System.String,Amazon.S3.AmazonS3Config)"> <summary> Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an AmazonS3Client Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonS3Client Configuration Object</param> </member> <member name="M:Amazon.S3.AmazonS3Client.AbortMultipartUpload(System.String,System.String,System.String)"> <summary> Aborts a multipart upload. <para> To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty. </para> </summary> <param name="bucketName">A property of AbortMultipartUploadRequest used to execute the AbortMultipartUpload service method.</param> <param name="key">A property of AbortMultipartUploadRequest used to execute the AbortMultipartUpload service method.</param> <param name="uploadId">A property of AbortMultipartUploadRequest used to execute the AbortMultipartUpload service method.</param> <returns>The response from the AbortMultipartUpload service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.AbortMultipartUpload(Amazon.S3.Model.AbortMultipartUploadRequest)"> <summary> Aborts a multipart upload. <para> To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty. </para> </summary> <param name="request">Container for the necessary parameters to execute the AbortMultipartUpload service method.</param> <returns>The response from the AbortMultipartUpload service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.AbortMultipartUploadAsync(Amazon.S3.Model.AbortMultipartUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AbortMultipartUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the AbortMultipartUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.CompleteMultipartUpload(Amazon.S3.Model.CompleteMultipartUploadRequest)"> <summary> Completes a multipart upload by assembling previously uploaded parts. </summary> <param name="request">Container for the necessary parameters to execute the CompleteMultipartUpload service method.</param> <returns>The response from the CompleteMultipartUpload service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.CompleteMultipartUploadAsync(Amazon.S3.Model.CompleteMultipartUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CompleteMultipartUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the CompleteMultipartUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.CopyObject(System.String,System.String,System.String,System.String)"> <summary> Creates a copy of an object that is already stored in Amazon S3. </summary> <param name="sourceBucket">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <param name="sourceKey">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <param name="destinationBucket">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <param name="destinationKey">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <returns>The response from the CopyObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.CopyObject(System.String,System.String,System.String,System.String,System.String)"> <summary> Creates a copy of an object that is already stored in Amazon S3. </summary> <param name="sourceBucket">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <param name="sourceKey">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <param name="sourceVersionId">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <param name="destinationBucket">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <param name="destinationKey">A property of CopyObjectRequest used to execute the CopyObject service method.</param> <returns>The response from the CopyObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.CopyObject(Amazon.S3.Model.CopyObjectRequest)"> <summary> Creates a copy of an object that is already stored in Amazon S3. </summary> <param name="request">Container for the necessary parameters to execute the CopyObject service method.</param> <returns>The response from the CopyObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.CopyObjectAsync(Amazon.S3.Model.CopyObjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopyObject operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyObject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.CopyPart(System.String,System.String,System.String,System.String,System.String)"> <summary> Uploads a part by copying data from an existing object as data source. </summary> <param name="sourceBucket">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="sourceKey">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="destinationBucket">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="destinationKey">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="uploadId">Upload ID identifying the multipart upload whose part is being copied.</param> <returns>The response from the CopyPart service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.CopyPart(System.String,System.String,System.String,System.String,System.String,System.String)"> <summary> Uploads a part by copying data from an existing object as data source. </summary> <param name="sourceBucket">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="sourceKey">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="sourceVersionId">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="destinationBucket">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="destinationKey">A property of CopyPartRequest used to execute the CopyPart service method.</param> <param name="uploadId">Upload ID identifying the multipart upload whose part is being copied.</param> <returns>The response from the CopyPart service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.CopyPart(Amazon.S3.Model.CopyPartRequest)"> <summary> Uploads a part by copying data from an existing object as data source. </summary> <param name="request">Container for the necessary parameters to execute the CopyPart service method.</param> <returns>The response from the CopyPart service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.CopyPartAsync(Amazon.S3.Model.CopyPartRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CopyPart operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyPart operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteBucket(System.String)"> <summary> Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted. </summary> <param name="bucketName">A property of DeleteBucketRequest used to execute the DeleteBucket service method.</param> <returns>The response from the DeleteBucket service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteBucket(Amazon.S3.Model.DeleteBucketRequest)"> <summary> Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucket service method.</param> <returns>The response from the DeleteBucket service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteBucketAsync(Amazon.S3.Model.DeleteBucketRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteBucket operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucket operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteBucketPolicy(System.String)"> <summary> Deletes the policy from the bucket. </summary> <param name="bucketName">A property of DeleteBucketPolicyRequest used to execute the DeleteBucketPolicy service method.</param> <returns>The response from the DeleteBucketPolicy service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteBucketPolicy(Amazon.S3.Model.DeleteBucketPolicyRequest)"> <summary> Deletes the policy from the bucket. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucketPolicy service method.</param> <returns>The response from the DeleteBucketPolicy service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteBucketPolicyAsync(Amazon.S3.Model.DeleteBucketPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteBucketPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucketPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteBucketReplication(Amazon.S3.Model.DeleteBucketReplicationRequest)"> <summary> Deletes the replication configuration for the given Amazon S3 bucket. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucketReplication service method.</param> <returns>The response from the DeleteBucketReplication service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteBucketReplicationAsync(Amazon.S3.Model.DeleteBucketReplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteBucketReplication operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucketReplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteBucketTagging(System.String)"> <summary> Deletes the tags from the bucket. </summary> <param name="bucketName">A property of DeleteBucketTaggingRequest used to execute the DeleteBucketTagging service method.</param> <returns>The response from the DeleteBucketTagging service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteBucketTagging(Amazon.S3.Model.DeleteBucketTaggingRequest)"> <summary> Deletes the tags from the bucket. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucketTagging service method.</param> <returns>The response from the DeleteBucketTagging service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteBucketTaggingAsync(Amazon.S3.Model.DeleteBucketTaggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteBucketTagging operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucketTagging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteBucketWebsite(System.String)"> <summary> This operation removes the website configuration from the bucket. </summary> <param name="bucketName">A property of DeleteBucketWebsiteRequest used to execute the DeleteBucketWebsite service method.</param> <returns>The response from the DeleteBucketWebsite service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteBucketWebsite(Amazon.S3.Model.DeleteBucketWebsiteRequest)"> <summary> This operation removes the website configuration from the bucket. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucketWebsite service method.</param> <returns>The response from the DeleteBucketWebsite service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteBucketWebsiteAsync(Amazon.S3.Model.DeleteBucketWebsiteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteBucketWebsite operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBucketWebsite operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteCORSConfiguration(System.String)"> <summary> Deletes the cors configuration information set for the bucket. </summary> <param name="bucketName">A property of DeleteCORSConfigurationRequest used to execute the DeleteCORSConfiguration service method.</param> <returns>The response from the DeleteCORSConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteCORSConfiguration(Amazon.S3.Model.DeleteCORSConfigurationRequest)"> <summary> Deletes the cors configuration information set for the bucket. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCORSConfiguration service method.</param> <returns>The response from the DeleteCORSConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteCORSConfigurationAsync(Amazon.S3.Model.DeleteCORSConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteCORSConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCORSConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteLifecycleConfiguration(System.String)"> <summary> Deletes the lifecycle configuration from the bucket. </summary> <param name="bucketName">A property of DeleteLifecycleConfigurationRequest used to execute the DeleteLifecycleConfiguration service method.</param> <returns>The response from the DeleteLifecycleConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteLifecycleConfiguration(Amazon.S3.Model.DeleteLifecycleConfigurationRequest)"> <summary> Deletes the lifecycle configuration from the bucket. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method.</param> <returns>The response from the DeleteLifecycleConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteLifecycleConfigurationAsync(Amazon.S3.Model.DeleteLifecycleConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteLifecycleConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLifecycleConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteObject(System.String,System.String)"> <summary> Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects. </summary> <param name="bucketName">A property of DeleteObjectRequest used to execute the DeleteObject service method.</param> <param name="key">A property of DeleteObjectRequest used to execute the DeleteObject service method.</param> <returns>The response from the DeleteObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteObject(System.String,System.String,System.String)"> <summary> Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects. </summary> <param name="bucketName">A property of DeleteObjectRequest used to execute the DeleteObject service method.</param> <param name="key">A property of DeleteObjectRequest used to execute the DeleteObject service method.</param> <param name="versionId">VersionId used to reference a specific version of the object.</param> <returns>The response from the DeleteObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteObject(Amazon.S3.Model.DeleteObjectRequest)"> <summary> Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects. </summary> <param name="request">Container for the necessary parameters to execute the DeleteObject service method.</param> <returns>The response from the DeleteObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteObjectAsync(Amazon.S3.Model.DeleteObjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteObject operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteObject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteObjects(Amazon.S3.Model.DeleteObjectsRequest)"> <summary> This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys. </summary> <param name="request">Container for the necessary parameters to execute the DeleteObjects service method.</param> <returns>The response from the DeleteObjects service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.DeleteObjectsAsync(Amazon.S3.Model.DeleteObjectsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteObjects operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteObjects operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetACL(System.String)"> <summary> Gets the access control policy for the bucket. </summary> <param name="bucketName">A property of GetACLRequest used to execute the GetACL service method.</param> <returns>The response from the GetACL service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetACL(Amazon.S3.Model.GetACLRequest)"> <summary> Gets the access control policy for the bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetACL service method.</param> <returns>The response from the GetACL service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetACLAsync(Amazon.S3.Model.GetACLRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetACL operation. </summary> <param name="request">Container for the necessary parameters to execute the GetACL operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketLocation(System.String)"> <summary> Returns the region the bucket resides in. </summary> <param name="bucketName">A property of GetBucketLocationRequest used to execute the GetBucketLocation service method.</param> <returns>The response from the GetBucketLocation service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketLocation(Amazon.S3.Model.GetBucketLocationRequest)"> <summary> Returns the region the bucket resides in. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketLocation service method.</param> <returns>The response from the GetBucketLocation service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketLocationAsync(Amazon.S3.Model.GetBucketLocationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketLocation operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketLocation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketLogging(System.String)"> <summary> Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner. </summary> <param name="bucketName">A property of GetBucketLoggingRequest used to execute the GetBucketLogging service method.</param> <returns>The response from the GetBucketLogging service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketLogging(Amazon.S3.Model.GetBucketLoggingRequest)"> <summary> Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketLogging service method.</param> <returns>The response from the GetBucketLogging service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketLoggingAsync(Amazon.S3.Model.GetBucketLoggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketLogging operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketLogging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketNotification(System.String)"> <summary> Returns the notification configuration of a bucket. </summary> <param name="bucketName">Name of the bucket to get the notification configuration for.</param> <returns>The response from the GetBucketNotification service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketNotification(Amazon.S3.Model.GetBucketNotificationRequest)"> <summary> Returns the notification configuration of a bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketNotification service method.</param> <returns>The response from the GetBucketNotification service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketNotificationAsync(Amazon.S3.Model.GetBucketNotificationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketNotification operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketNotification operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketPolicy(System.String)"> <summary> Returns the policy of a specified bucket. </summary> <param name="bucketName">A property of GetBucketPolicyRequest used to execute the GetBucketPolicy service method.</param> <returns>The response from the GetBucketPolicy service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketPolicy(Amazon.S3.Model.GetBucketPolicyRequest)"> <summary> Returns the policy of a specified bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketPolicy service method.</param> <returns>The response from the GetBucketPolicy service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketPolicyAsync(Amazon.S3.Model.GetBucketPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketReplication(Amazon.S3.Model.GetBucketReplicationRequest)"> <summary> Retrieves the replication configuration for the given Amazon S3 bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketReplication service method.</param> <returns>The response from the GetBucketReplication service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketReplicationAsync(Amazon.S3.Model.GetBucketReplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketReplication operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketReplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketRequestPayment(System.String)"> <summary> Returns the request payment configuration of a bucket. </summary> <param name="bucketName">A property of GetBucketRequestPaymentRequest used to execute the GetBucketRequestPayment service method.</param> <returns>The response from the GetBucketRequestPayment service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketRequestPayment(Amazon.S3.Model.GetBucketRequestPaymentRequest)"> <summary> Returns the request payment configuration of a bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketRequestPayment service method.</param> <returns>The response from the GetBucketRequestPayment service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketRequestPaymentAsync(Amazon.S3.Model.GetBucketRequestPaymentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketRequestPayment operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketRequestPayment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketTagging(Amazon.S3.Model.GetBucketTaggingRequest)"> <summary> Returns the tag set associated with the bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketTagging service method.</param> <returns>The response from the GetBucketTagging service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketTaggingAsync(Amazon.S3.Model.GetBucketTaggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketTagging operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketTagging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketVersioning(System.String)"> <summary> Returns the versioning state of a bucket. </summary> <param name="bucketName">A property of GetBucketVersioningRequest used to execute the GetBucketVersioning service method.</param> <returns>The response from the GetBucketVersioning service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketVersioning(Amazon.S3.Model.GetBucketVersioningRequest)"> <summary> Returns the versioning state of a bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketVersioning service method.</param> <returns>The response from the GetBucketVersioning service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketVersioningAsync(Amazon.S3.Model.GetBucketVersioningRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketVersioning operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketVersioning operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketWebsite(System.String)"> <summary> Returns the website configuration for a bucket. </summary> <param name="bucketName">A property of GetBucketWebsiteRequest used to execute the GetBucketWebsite service method.</param> <returns>The response from the GetBucketWebsite service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketWebsite(Amazon.S3.Model.GetBucketWebsiteRequest)"> <summary> Returns the website configuration for a bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketWebsite service method.</param> <returns>The response from the GetBucketWebsite service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetBucketWebsiteAsync(Amazon.S3.Model.GetBucketWebsiteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetBucketWebsite operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBucketWebsite operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetCORSConfiguration(System.String)"> <summary> Returns the cors configuration for the bucket. </summary> <param name="bucketName">A property of GetCORSConfigurationRequest used to execute the GetCORSConfiguration service method.</param> <returns>The response from the GetCORSConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetCORSConfiguration(Amazon.S3.Model.GetCORSConfigurationRequest)"> <summary> Returns the cors configuration for the bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetCORSConfiguration service method.</param> <returns>The response from the GetCORSConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetCORSConfigurationAsync(Amazon.S3.Model.GetCORSConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetCORSConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCORSConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetLifecycleConfiguration(System.String)"> <summary> Returns the lifecycle configuration information set on the bucket. </summary> <param name="bucketName">A property of GetLifecycleConfigurationRequest used to execute the GetLifecycleConfiguration service method.</param> <returns>The response from the GetLifecycleConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetLifecycleConfiguration(Amazon.S3.Model.GetLifecycleConfigurationRequest)"> <summary> Returns the lifecycle configuration information set on the bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetLifecycleConfiguration service method.</param> <returns>The response from the GetLifecycleConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetLifecycleConfigurationAsync(Amazon.S3.Model.GetLifecycleConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetLifecycleConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the GetLifecycleConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetObject(System.String,System.String)"> <summary> Retrieves objects from Amazon S3. </summary> <param name="bucketName">A property of GetObjectRequest used to execute the GetObject service method.</param> <param name="key">A property of GetObjectRequest used to execute the GetObject service method.</param> <returns>The response from the GetObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetObject(System.String,System.String,System.String)"> <summary> Retrieves objects from Amazon S3. </summary> <param name="bucketName">A property of GetObjectRequest used to execute the GetObject service method.</param> <param name="key">A property of GetObjectRequest used to execute the GetObject service method.</param> <param name="versionId">VersionId used to reference a specific version of the object.</param> <returns>The response from the GetObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetObject(Amazon.S3.Model.GetObjectRequest)"> <summary> Retrieves objects from Amazon S3. </summary> <param name="request">Container for the necessary parameters to execute the GetObject service method.</param> <returns>The response from the GetObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetObjectAsync(Amazon.S3.Model.GetObjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetObject operation. </summary> <param name="request">Container for the necessary parameters to execute the GetObject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetObjectMetadata(System.String,System.String)"> <summary> The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. </summary> <param name="bucketName">A property of GetObjectMetadataRequest used to execute the GetObjectMetadata service method.</param> <param name="key">A property of GetObjectMetadataRequest used to execute the GetObjectMetadata service method.</param> <returns>The response from the GetObjectMetadata service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetObjectMetadata(System.String,System.String,System.String)"> <summary> The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. </summary> <param name="bucketName">A property of GetObjectMetadataRequest used to execute the GetObjectMetadata service method.</param> <param name="key">A property of GetObjectMetadataRequest used to execute the GetObjectMetadata service method.</param> <param name="versionId">VersionId used to reference a specific version of the object.</param> <returns>The response from the GetObjectMetadata service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetObjectMetadata(Amazon.S3.Model.GetObjectMetadataRequest)"> <summary> The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. </summary> <param name="request">Container for the necessary parameters to execute the GetObjectMetadata service method.</param> <returns>The response from the GetObjectMetadata service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetObjectMetadataAsync(Amazon.S3.Model.GetObjectMetadataRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetObjectMetadata operation. </summary> <param name="request">Container for the necessary parameters to execute the GetObjectMetadata operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetObjectTorrent(System.String,System.String)"> <summary> Return torrent files from a bucket. </summary> <param name="bucketName">A property of GetObjectTorrentRequest used to execute the GetObjectTorrent service method.</param> <param name="key">A property of GetObjectTorrentRequest used to execute the GetObjectTorrent service method.</param> <returns>The response from the GetObjectTorrent service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetObjectTorrent(Amazon.S3.Model.GetObjectTorrentRequest)"> <summary> Return torrent files from a bucket. </summary> <param name="request">Container for the necessary parameters to execute the GetObjectTorrent service method.</param> <returns>The response from the GetObjectTorrent service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetObjectTorrentAsync(Amazon.S3.Model.GetObjectTorrentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetObjectTorrent operation. </summary> <param name="request">Container for the necessary parameters to execute the GetObjectTorrent operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.HeadBucket(Amazon.S3.Model.HeadBucketRequest)"> <summary> This operation is useful to determine if a bucket exists and you have permission to access it. </summary> <param name="request">Container for the necessary parameters to execute the HeadBucket service method.</param> <returns>The response from the HeadBucket service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.HeadBucketAsync(Amazon.S3.Model.HeadBucketRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the HeadBucket operation. </summary> <param name="request">Container for the necessary parameters to execute the HeadBucket operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.InitiateMultipartUpload(System.String,System.String)"> <summary> Initiates a multipart upload and returns an upload ID. <para> <b>Note:</b> After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. </para> </summary> <param name="bucketName">A property of InitiateMultipartUploadRequest used to execute the InitiateMultipartUpload service method.</param> <param name="key">A property of InitiateMultipartUploadRequest used to execute the InitiateMultipartUpload service method.</param> <returns>The response from the InitiateMultipartUpload service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.InitiateMultipartUpload(Amazon.S3.Model.InitiateMultipartUploadRequest)"> <summary> Initiates a multipart upload and returns an upload ID. <para> <b>Note:</b> After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. </para> </summary> <param name="request">Container for the necessary parameters to execute the InitiateMultipartUpload service method.</param> <returns>The response from the InitiateMultipartUpload service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.InitiateMultipartUploadAsync(Amazon.S3.Model.InitiateMultipartUploadRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the InitiateMultipartUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the InitiateMultipartUpload operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListBuckets"> <summary> Returns a list of all buckets owned by the authenticated sender of the request. </summary> <returns>The response from the ListBuckets service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListBuckets(Amazon.S3.Model.ListBucketsRequest)"> <summary> Returns a list of all buckets owned by the authenticated sender of the request. </summary> <param name="request">Container for the necessary parameters to execute the ListBuckets service method.</param> <returns>The response from the ListBuckets service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListBucketsAsync(Amazon.S3.Model.ListBucketsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListBuckets operation. </summary> <param name="request">Container for the necessary parameters to execute the ListBuckets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListMultipartUploads(System.String)"> <summary> This operation lists in-progress multipart uploads. </summary> <param name="bucketName">A property of ListMultipartUploadsRequest used to execute the ListMultipartUploads service method.</param> <returns>The response from the ListMultipartUploads service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListMultipartUploads(System.String,System.String)"> <summary> This operation lists in-progress multipart uploads. </summary> <param name="bucketName">A property of ListMultipartUploadsRequest used to execute the ListMultipartUploads service method.</param> <param name="prefix">Lists in-progress uploads only for those keys that begin with the specified prefix.</param> <returns>The response from the ListMultipartUploads service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListMultipartUploads(Amazon.S3.Model.ListMultipartUploadsRequest)"> <summary> This operation lists in-progress multipart uploads. </summary> <param name="request">Container for the necessary parameters to execute the ListMultipartUploads service method.</param> <returns>The response from the ListMultipartUploads service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListMultipartUploadsAsync(Amazon.S3.Model.ListMultipartUploadsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListMultipartUploads operation. </summary> <param name="request">Container for the necessary parameters to execute the ListMultipartUploads operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListObjects(System.String)"> <summary> Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. </summary> <param name="bucketName">A property of ListObjectsRequest used to execute the ListObjects service method.</param> <returns>The response from the ListObjects service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListObjects(System.String,System.String)"> <summary> Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. </summary> <param name="bucketName">A property of ListObjectsRequest used to execute the ListObjects service method.</param> <param name="prefix">Limits the response to keys that begin with the specified prefix.</param> <returns>The response from the ListObjects service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListObjects(Amazon.S3.Model.ListObjectsRequest)"> <summary> Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. </summary> <param name="request">Container for the necessary parameters to execute the ListObjects service method.</param> <returns>The response from the ListObjects service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListObjectsAsync(Amazon.S3.Model.ListObjectsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListObjects operation. </summary> <param name="request">Container for the necessary parameters to execute the ListObjects operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListParts(System.String,System.String,System.String)"> <summary> Lists the parts that have been uploaded for a specific multipart upload. </summary> <param name="bucketName">A property of ListPartsRequest used to execute the ListParts service method.</param> <param name="key">A property of ListPartsRequest used to execute the ListParts service method.</param> <param name="uploadId">Upload ID identifying the multipart upload whose parts are being listed.</param> <returns>The response from the ListParts service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListParts(Amazon.S3.Model.ListPartsRequest)"> <summary> Lists the parts that have been uploaded for a specific multipart upload. </summary> <param name="request">Container for the necessary parameters to execute the ListParts service method.</param> <returns>The response from the ListParts service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListPartsAsync(Amazon.S3.Model.ListPartsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListParts operation. </summary> <param name="request">Container for the necessary parameters to execute the ListParts operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListVersions(System.String)"> <summary> Returns metadata about all of the versions of objects in a bucket. </summary> <param name="bucketName">A property of ListVersionsRequest used to execute the ListVersions service method.</param> <returns>The response from the ListVersions service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListVersions(System.String,System.String)"> <summary> Returns metadata about all of the versions of objects in a bucket. </summary> <param name="bucketName">A property of ListVersionsRequest used to execute the ListVersions service method.</param> <param name="prefix">Limits the response to keys that begin with the specified prefix.</param> <returns>The response from the ListVersions service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListVersions(Amazon.S3.Model.ListVersionsRequest)"> <summary> Returns metadata about all of the versions of objects in a bucket. </summary> <param name="request">Container for the necessary parameters to execute the ListVersions service method.</param> <returns>The response from the ListVersions service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.ListVersionsAsync(Amazon.S3.Model.ListVersionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListVersions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListVersions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutACL(Amazon.S3.Model.PutACLRequest)"> <summary> Sets the permissions on a bucket using access control lists (ACL). </summary> <param name="request">Container for the necessary parameters to execute the PutACL service method.</param> <returns>The response from the PutACL service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutACLAsync(Amazon.S3.Model.PutACLRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutACL operation. </summary> <param name="request">Container for the necessary parameters to execute the PutACL operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucket(System.String)"> <summary> Creates a new bucket. </summary> <param name="bucketName">A property of PutBucketRequest used to execute the PutBucket service method.</param> <returns>The response from the PutBucket service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucket(Amazon.S3.Model.PutBucketRequest)"> <summary> Creates a new bucket. </summary> <param name="request">Container for the necessary parameters to execute the PutBucket service method.</param> <returns>The response from the PutBucket service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketAsync(Amazon.S3.Model.PutBucketRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucket operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucket operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketLogging(Amazon.S3.Model.PutBucketLoggingRequest)"> <summary> Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketLogging service method.</param> <returns>The response from the PutBucketLogging service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketLoggingAsync(Amazon.S3.Model.PutBucketLoggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucketLogging operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketLogging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketNotification(Amazon.S3.Model.PutBucketNotificationRequest)"> <summary> Enables notifications of specified events for a bucket. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketNotification service method.</param> <returns>The response from the PutBucketNotification service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketNotificationAsync(Amazon.S3.Model.PutBucketNotificationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucketNotification operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketNotification operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketPolicy(System.String,System.String)"> <summary> Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. </summary> <param name="bucketName">A property of PutBucketPolicyRequest used to execute the PutBucketPolicy service method.</param> <param name="policy">The bucket policy as a JSON document.</param> <returns>The response from the PutBucketPolicy service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketPolicy(System.String,System.String,System.String)"> <summary> Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. </summary> <param name="bucketName">A property of PutBucketPolicyRequest used to execute the PutBucketPolicy service method.</param> <param name="policy">The bucket policy as a JSON document.</param> <param name="contentMD5">A property of PutBucketPolicyRequest used to execute the PutBucketPolicy service method.</param> <returns>The response from the PutBucketPolicy service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketPolicy(Amazon.S3.Model.PutBucketPolicyRequest)"> <summary> Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketPolicy service method.</param> <returns>The response from the PutBucketPolicy service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketPolicyAsync(Amazon.S3.Model.PutBucketPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucketPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketReplication(Amazon.S3.Model.PutBucketReplicationRequest)"> <summary> Creates a new replication configuration (or replaces an existing one, if present). </summary> <param name="request">Container for the necessary parameters to execute the PutBucketReplication service method.</param> <returns>The response from the PutBucketReplication service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketReplicationAsync(Amazon.S3.Model.PutBucketReplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucketReplication operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketReplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketRequestPayment(System.String,Amazon.S3.Model.RequestPaymentConfiguration)"> <summary> Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html </summary> <param name="bucketName">A property of PutBucketRequestPaymentRequest used to execute the PutBucketRequestPayment service method.</param> <param name="requestPaymentConfiguration">A property of PutBucketRequestPaymentRequest used to execute the PutBucketRequestPayment service method.</param> <returns>The response from the PutBucketRequestPayment service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketRequestPayment(Amazon.S3.Model.PutBucketRequestPaymentRequest)"> <summary> Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html </summary> <param name="request">Container for the necessary parameters to execute the PutBucketRequestPayment service method.</param> <returns>The response from the PutBucketRequestPayment service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketRequestPaymentAsync(Amazon.S3.Model.PutBucketRequestPaymentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucketRequestPayment operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketRequestPayment operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketTagging(System.String,System.Collections.Generic.List{Amazon.S3.Model.Tag})"> <summary> Sets the tags for a bucket. </summary> <param name="bucketName">A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method.</param> <param name="tagSet">A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method.</param> <returns>The response from the PutBucketTagging service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketTagging(Amazon.S3.Model.PutBucketTaggingRequest)"> <summary> Sets the tags for a bucket. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketTagging service method.</param> <returns>The response from the PutBucketTagging service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketTaggingAsync(Amazon.S3.Model.PutBucketTaggingRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucketTagging operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketTagging operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketVersioning(Amazon.S3.Model.PutBucketVersioningRequest)"> <summary> Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketVersioning service method.</param> <returns>The response from the PutBucketVersioning service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketVersioningAsync(Amazon.S3.Model.PutBucketVersioningRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucketVersioning operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketVersioning operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketWebsite(System.String,Amazon.S3.Model.WebsiteConfiguration)"> <summary> Set the website configuration for a bucket. </summary> <param name="bucketName">A property of PutBucketWebsiteRequest used to execute the PutBucketWebsite service method.</param> <param name="websiteConfiguration">A property of PutBucketWebsiteRequest used to execute the PutBucketWebsite service method.</param> <returns>The response from the PutBucketWebsite service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketWebsite(Amazon.S3.Model.PutBucketWebsiteRequest)"> <summary> Set the website configuration for a bucket. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketWebsite service method.</param> <returns>The response from the PutBucketWebsite service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutBucketWebsiteAsync(Amazon.S3.Model.PutBucketWebsiteRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutBucketWebsite operation. </summary> <param name="request">Container for the necessary parameters to execute the PutBucketWebsite operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutCORSConfiguration(System.String,Amazon.S3.Model.CORSConfiguration)"> <summary> Sets the cors configuration for a bucket. </summary> <param name="bucketName">A property of PutCORSConfigurationRequest used to execute the PutCORSConfiguration service method.</param> <param name="configuration">A property of PutCORSConfigurationRequest used to execute the PutCORSConfiguration service method.</param> <returns>The response from the PutCORSConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutCORSConfiguration(Amazon.S3.Model.PutCORSConfigurationRequest)"> <summary> Sets the cors configuration for a bucket. </summary> <param name="request">Container for the necessary parameters to execute the PutCORSConfiguration service method.</param> <returns>The response from the PutCORSConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutCORSConfigurationAsync(Amazon.S3.Model.PutCORSConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutCORSConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the PutCORSConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutLifecycleConfiguration(System.String,Amazon.S3.Model.LifecycleConfiguration)"> <summary> Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. </summary> <param name="bucketName">A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method.</param> <param name="configuration">A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method.</param> <returns>The response from the PutLifecycleConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutLifecycleConfiguration(Amazon.S3.Model.PutLifecycleConfigurationRequest)"> <summary> Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. </summary> <param name="request">Container for the necessary parameters to execute the PutLifecycleConfiguration service method.</param> <returns>The response from the PutLifecycleConfiguration service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutLifecycleConfigurationAsync(Amazon.S3.Model.PutLifecycleConfigurationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutLifecycleConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the PutLifecycleConfiguration operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutObject(Amazon.S3.Model.PutObjectRequest)"> <summary> Adds an object to a bucket. </summary> <param name="request">Container for the necessary parameters to execute the PutObject service method.</param> <returns>The response from the PutObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.PutObjectAsync(Amazon.S3.Model.PutObjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutObject operation. </summary> <param name="request">Container for the necessary parameters to execute the PutObject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.RestoreObject(System.String,System.String)"> <summary> Restores an archived copy of an object back into Amazon S3 </summary> <param name="bucketName">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <param name="key">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <returns>The response from the RestoreObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.RestoreObject(System.String,System.String,System.Int32)"> <summary> Restores an archived copy of an object back into Amazon S3 </summary> <param name="bucketName">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <param name="key">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <param name="days">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <returns>The response from the RestoreObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.RestoreObject(System.String,System.String,System.String)"> <summary> Restores an archived copy of an object back into Amazon S3 </summary> <param name="bucketName">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <param name="key">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <param name="versionId">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <returns>The response from the RestoreObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.RestoreObject(System.String,System.String,System.String,System.Int32)"> <summary> Restores an archived copy of an object back into Amazon S3 </summary> <param name="bucketName">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <param name="key">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <param name="versionId">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <param name="days">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> <returns>The response from the RestoreObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.RestoreObject(Amazon.S3.Model.RestoreObjectRequest)"> <summary> Restores an archived copy of an object back into Amazon S3 </summary> <param name="request">Container for the necessary parameters to execute the RestoreObject service method.</param> <returns>The response from the RestoreObject service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.RestoreObjectAsync(Amazon.S3.Model.RestoreObjectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RestoreObject operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreObject operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.UploadPart(Amazon.S3.Model.UploadPartRequest)"> <summary> Uploads a part in a multipart upload. <para> <b>Note:</b> After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. </para> </summary> <param name="request">Container for the necessary parameters to execute the UploadPart service method.</param> <returns>The response from the UploadPart service method, as returned by S3.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.UploadPartAsync(Amazon.S3.Model.UploadPartRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UploadPart operation. </summary> <param name="request">Container for the necessary parameters to execute the UploadPart operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.AmazonS3Client.GetPreSignedURL(Amazon.S3.Model.GetPreSignedUrlRequest)"> <summary> Create a signed URL allowing access to a resource that would usually require authentication. </summary> <remarks> <para> When using query string authentication you create a query, specify an expiration time for the query, sign it with your signature, place the data in an HTTP request, and distribute the request to a user or embed the request in a web page. </para> <para> A PreSigned URL can be generated for GET, PUT, DELETE and HEAD operations on your bucketName, keys, and versions. </para> </remarks> <param name="request">The GetPreSignedUrlRequest that defines the parameters of the operation.</param> <returns>A string that is the signed http request.</returns> <exception cref="T:System.ArgumentException" /> <exception cref="T:System.ArgumentNullException" /> </member> <member name="M:Amazon.S3.AmazonS3Client.Marshall(Amazon.S3.Model.GetPreSignedUrlRequest,System.String,System.String,System.Boolean)"> <summary> Marshalls the parameters for a presigned url for a preferred signing protocol. </summary> <param name="getPreSignedUrlRequest"></param> <param name="accessKey"></param> <param name="token"></param> <param name="aws4Signing"> True if AWS4 signing will be used; if the expiry period in the request exceeds the maximum allowed for AWS4 (one week), an ArgumentException is thrown. </param> <returns></returns> </member> <member name="T:Amazon.S3.Model.GetObjectResponse"> <summary> Returns information about the GetObject response and response metadata. </summary> </member> <member name="T:Amazon.S3.Model.StreamResponse"> <summary> Base class for responses that return a stream. </summary> </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="M:Amazon.S3.Model.StreamResponse.Dispose"> <summary> Disposes of all managed and unmanaged resources. </summary> </member> <member name="P:Amazon.S3.Model.StreamResponse.ResponseStream"> <summary> An open stream read from to get the data from S3. In order to use this stream without leaking the underlying resource, please wrap access to the stream within a using block. </summary> </member> <member name="M:Amazon.S3.Model.GetObjectResponse.WriteResponseStreamToFileAsync(System.String,System.Boolean,System.Threading.CancellationToken)"> <summary> Writes the content of the ResponseStream a file indicated by the filePath argument. </summary> <param name="filePath">The location where to write the ResponseStream</param> <param name="append">Whether or not to append to the file if it exists</param> <param name="cancellationToken">Cancellation token which can be used to cancel this operation.</param> </member> <member name="M:Amazon.S3.Model.GetObjectResponse.IsSetServerSideEncryptionKeyManagementServiceKeyId"> <summary> Checks if ServerSideEncryptionKeyManagementServiceKeyId property is set. </summary> <returns>true if ServerSideEncryptionKeyManagementServiceKeyId property is set.</returns> </member> <member name="M:Amazon.S3.Model.GetObjectResponse.IsSetReplicationStatus"> <summary> Checks if ReplicationStatus property is set. </summary> <returns>true if ReplicationStatus property is set.</returns> </member> <member name="M:Amazon.S3.Model.GetObjectResponse.WriteResponseStreamToFile(System.String)"> <summary> Writes the content of the ResponseStream a file indicated by the filePath argument. </summary> <param name="filePath">The location where to write the ResponseStream</param> </member> <member name="M:Amazon.S3.Model.GetObjectResponse.WriteResponseStreamToFile(System.String,System.Boolean)"> <summary> Writes the content of the ResponseStream a file indicated by the filePath argument. </summary> <param name="filePath">The location where to write the ResponseStream</param> <param name="append">Whether or not to append to the file if it exists</param> </member> <member name="M:Amazon.S3.Model.GetObjectResponse.OnRaiseProgressEvent(System.String,System.Int64,System.Int64,System.Int64)"> <summary> This method is called by a producer of write object progress notifications. When called, all the subscribers in the invocation list will be called sequentially. </summary> <param name="file">The file being written.</param> <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.S3.Model.GetObjectResponse.BucketName"> <summary> Gets and sets the BucketName property. </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.Key"> <summary> Gets and sets the Key property. </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.DeleteMarker"> <summary> Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response. </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.Headers"> <summary> The collection of headers for the request. </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.Metadata"> <summary> The collection of meta data for the request. </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.Expiration"> <summary> Gets and sets the Expiration property. Specifies the expiration date for the object and the rule governing the expiration. Is null if expiration is not applicable. </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.RestoreExpiration"> <summary> Gets and sets the RestoreExpiration property. RestoreExpiration will be set for objects that have been restored from Amazon Glacier. It indiciates for those objects how long the restored object will exist. </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.RestoreInProgress"> <summary> Gets and sets the RestoreInProgress Will be true when the object is in the process of being restored from Amazon Glacier. </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.LastModified"> <summary> Last modified date of the object </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.ETag"> <summary> An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.MissingMeta"> <summary> This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers. </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.VersionId"> <summary> Version of the object. </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.Expires"> <summary> The date and time at which the object is no longer cacheable. </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.WebsiteRedirectLocation"> <summary> If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.ServerSideEncryptionMethod"> <summary> The Server-side encryption algorithm used when storing this object in S3. </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.StorageClass"> <summary> The class of storage used to store the object. </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.ServerSideEncryptionKeyManagementServiceKeyId"> <summary> The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object. </summary> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.ReplicationStatus"> <summary> The status of the replication job associated with this source object. </summary> </member> <member name="E:Amazon.S3.Model.GetObjectResponse.WriteObjectProgressEvent"> <summary> The event for Write Object progress notifications. All subscribers will be notified when a new progress event is raised. </summary> <remarks> Subscribe to this event if you want to receive put object progress notifications. Here is how:<br /> 1. Define a method with a signature similar to this one: <code> private void displayProgress(object sender, WriteObjectProgressArgs args) { Console.WriteLine(args); } </code> 2. Add this method to the Put Object Progress Event delegate's invocation list <code> GetObjectResponse response = s3Client.GetObject(request); response.WriteObjectProgressEvent += displayProgress; </code> </remarks> </member> <member name="P:Amazon.S3.Model.GetObjectResponse.ServerSideEncryptionCustomerMethod"> <summary> The Server-side encryption algorithm to be used with the customer provided key. </summary> </member> <member name="M:Amazon.S3.Transfer.Internal.BaseCommand.WhenAllOrFirstExceptionAsync``1(System.Collections.Generic.List{System.Threading.Tasks.Task{``0}},System.Threading.CancellationToken)"> <summary> Waits for all of the tasks to complete or till any task fails. </summary> </member> <member name="M:Amazon.S3.Transfer.Internal.BaseCommand.WhenAllOrFirstExceptionAsync(System.Collections.Generic.List{System.Threading.Tasks.Task},System.Threading.CancellationToken)"> <summary> Waits for all of the tasks to complete or till any task fails. </summary> </member> <member name="T:Amazon.S3.Transfer.Internal.MultipartUploadCommand"> <summary> The command to manage an upload using the S3 multipart API. </summary> </member> <member name="M:Amazon.S3.Transfer.Internal.MultipartUploadCommand.#ctor(Amazon.S3.IAmazonS3,Amazon.S3.Transfer.TransferUtilityConfig,Amazon.S3.Transfer.TransferUtilityUploadRequest)"> <summary> Initializes a new instance of the <see cref="T:Amazon.S3.Transfer.Internal.MultipartUploadCommand"/> class. </summary> <param name="s3Client">The s3 client.</param> <param name="config">The config object that has the number of threads to use.</param> <param name="fileTransporterRequest">The file transporter request.</param> </member> <member name="T:Amazon.S3.Transfer.Internal.SimpleUploadCommand"> <summary> This command is for doing regular PutObject requests. </summary> </member> <member name="T:Amazon.S3.Transfer.Internal.UploadDirectoryCommand"> <summary> This command files all the files that meets the criteria specified in the TransferUtilityUploadDirectoryRequest request and uploads them. </summary> </member> <member name="T:Amazon.S3.Transfer.TransferUtility"> <summary> <para> Provides a high level utility for managing transfers to and from Amazon S3. </para> <para> <c>TransferUtility</c> provides a simple API for uploading content to and downloading content from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance, and reliability. </para> <para> When uploading large files by specifying file paths instead of a stream, <c>TransferUtility</c> uses multiple threads to upload multiple parts of a single upload at once. When dealing with large content sizes and high bandwidth, this can increase throughput significantly. </para> </summary> <remarks> <para> Transfers are stored in memory. If the application is restarted, previous transfers are no longer accessible. In this situation, if necessary, you should clean up any multipart uploads that are incomplete. </para> </remarks> <summary> <para> Provides a high level utility for managing transfers to and from Amazon S3. </para> <para> <c>TransferUtility</c> provides a simple API for uploading content to and downloading content from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance, and reliability. </para> <para> When uploading large files by specifying file paths instead of a stream, <c>TransferUtility</c> uses multiple threads to upload multiple parts of a single upload at once. When dealing with large content sizes and high bandwidth, this can increase throughput significantly. </para> </summary> <remarks> <para> Transfers are stored in memory. If the application is restarted, previous transfers are no longer accessible. In this situation, if necessary, you should clean up any multipart uploads that are incomplete. </para> </remarks> <summary> <para> Provides a high level utility for managing transfers to and from Amazon S3. </para> <para> <c>TransferUtility</c> provides a simple API for uploading content to and downloading content from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance, and reliability. </para> <para> When uploading large files by specifying file paths instead of a stream, <c>TransferUtility</c> uses multiple threads to upload multiple parts of a single upload at once. When dealing with large content sizes and high bandwidth, this can increase throughput significantly. </para> </summary> <remarks> <para> Transfers are stored in memory. If the application is restarted, previous transfers are no longer accessible. In this situation, if necessary, you should clean up any multipart uploads that are incomplete. </para> </remarks> <summary> <para> Provides a high level utility for managing transfers to and from Amazon S3. </para> <para> <c>TransferUtility</c> provides a simple API for uploading content to and downloading content from Amazon S3. It makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance, and reliability. </para> <para> When uploading large files by specifying file paths instead of a stream, <c>TransferUtility</c> uses multiple threads to upload multiple parts of a single upload at once. When dealing with large content sizes and high bandwidth, this can increase throughput significantly. </para> </summary> <remarks> <para> Transfers are stored in memory. If the application is restarted, previous transfers are no longer accessible. In this situation, if necessary, you should clean up any multipart uploads that are incomplete. </para> </remarks> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.UploadDirectoryAsync(System.String,System.String,System.Threading.CancellationToken)"> <summary> Uploads files from a specified directory. The object key is derived from the file names inside the directory. For large uploads, the file will be divided and uploaded in parts using Amazon S3's multipart API. The parts will be reassembled as one object in Amazon S3. </summary> <remarks> <para> If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. </para> </remarks> <param name="directory"> The source directory, that is, the directory containing the files to upload. </param> <param name="bucketName"> The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. </param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.UploadDirectoryAsync(System.String,System.String,System.String,System.IO.SearchOption,System.Threading.CancellationToken)"> <summary> Uploads files from a specified directory. The object key is derived from the file names inside the directory. For large uploads, the file will be divided and uploaded in parts using Amazon S3's multipart API. The parts will be reassembled as one object in Amazon S3. </summary> <remarks> <para> If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. </para> </remarks> <param name="directory"> The source directory, that is, the directory containing the files to upload. </param> <param name="bucketName"> The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. </param> <param name="searchPattern"> A pattern used to identify the files from the source directory to upload. </param> <param name="searchOption"> A search option that specifies whether to recursively search for files to upload in subdirectories. </param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.UploadDirectoryAsync(Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest,System.Threading.CancellationToken)"> <summary> Uploads files from a specified directory. The object key is derived from the file names inside the directory. For large uploads, the file will be divided and uploaded in parts using Amazon S3's multipart API. The parts will be reassembled as one object in Amazon S3. </summary> <remarks> <para> If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. </para> </remarks> <param name="request"> The request that contains all the parameters required to upload a directory. </param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.DownloadDirectoryAsync(System.String,System.String,System.String,System.Threading.CancellationToken)"> <summary> Downloads the objects in Amazon S3 that have a key that starts with the value specified by <c>s3Directory</c>. </summary> <param name="bucketName"> The name of the bucket containing the Amazon S3 objects to download. </param> <param name="s3Directory"> The directory in Amazon S3 to download. </param> <param name="localDirectory"> The local directory to download the objects to. </param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.DownloadDirectoryAsync(Amazon.S3.Transfer.TransferUtilityDownloadDirectoryRequest,System.Threading.CancellationToken)"> <summary> Downloads the objects in Amazon S3 that have a key that starts with the value specified by the <c>S3Directory</c> property of the passed in <c>TransferUtilityDownloadDirectoryRequest</c> object. </summary> <param name="request"> Contains all the parameters required to download objects from Amazon S3 into a local directory. </param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.DownloadAsync(System.String,System.String,System.String,System.Threading.CancellationToken)"> <summary> Downloads the content from Amazon S3 and writes it to the specified file. </summary> <param name="filePath"> The file path where the content from Amazon S3 will be written to. </param> <param name="bucketName"> The name of the bucket containing the Amazon S3 object to download. </param> <param name="key"> The key under which the Amazon S3 object is stored. </param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.UploadAsync(System.String,System.String,System.Threading.CancellationToken)"> <summary> Uploads the specified file. The object key is derived from the file's name. Multiple threads are used to read the file and perform multiple uploads in parallel. For large uploads, the file will be divided and uploaded in parts using Amazon S3's multipart API. The parts will be reassembled as one object in Amazon S3. </summary> <remarks> <para> If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. </para> </remarks> <param name="filePath"> The file path of the file to upload. </param> <param name="bucketName"> The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. </param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.UploadAsync(System.String,System.String,System.String,System.Threading.CancellationToken)"> <summary> Uploads the specified file. Multiple threads are used to read the file and perform multiple uploads in parallel. For large uploads, the file will be divided and uploaded in parts using Amazon S3's multipart API. The parts will be reassembled as one object in Amazon S3. </summary> <remarks> <para> If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. </para> </remarks> <param name="filePath"> The file path of the file to upload. </param> <param name="bucketName"> The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. </param> <param name="key"> The key under which the Amazon S3 object is stored. </param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.UploadAsync(System.IO.Stream,System.String,System.String,System.Threading.CancellationToken)"> <summary> Uploads the contents of the specified stream. For large uploads, the file will be divided and uploaded in parts using Amazon S3's multipart API. The parts will be reassembled as one object in Amazon S3. </summary> <remarks> <para> If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. </para> </remarks> <param name="stream"> The stream to read to obtain the content to upload. </param> <param name="bucketName"> The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. </param> <param name="key"> The key under which the Amazon S3 object is stored. </param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.UploadAsync(Amazon.S3.Transfer.TransferUtilityUploadRequest,System.Threading.CancellationToken)"> <summary> Uploads the file or stream specified by the request. To track the progress of the upload, add an event listener to the request's <c>UploadProgressEvent</c>. For large uploads, the file will be divided and uploaded in parts using Amazon S3's multipart API. The parts will be reassembled as one object in Amazon S3. </summary> <remarks> <para> If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke TransferUtility.AbortMultipartUploadsAsync() to abort the incomplete multipart uploads. </para> </remarks> <param name="request"> Contains all the parameters required to upload to Amazon S3. </param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.AbortMultipartUploadsAsync(System.String,System.DateTime,System.Threading.CancellationToken)"> <summary> Aborts the multipart uploads that were initiated before the specified date. </summary> <param name="bucketName"> The name of the bucket containing multipart uploads. </param> <param name="initiatedDate"> The date before which the multipart uploads were initiated. </param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.DownloadAsync(Amazon.S3.Transfer.TransferUtilityDownloadRequest,System.Threading.CancellationToken)"> <summary> Downloads the content from Amazon S3 and writes it to the specified file. If the key is not specified in the request parameter, the file name will used as the key name. </summary> <param name="request"> Contains all the parameters required to download an Amazon S3 object. </param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.OpenStreamAsync(System.String,System.String,System.Threading.CancellationToken)"> <summary> Returns a stream from which the caller can read the content from the specified Amazon S3 bucket and key. The caller of this method is responsible for closing the stream. </summary> <param name="bucketName"> The name of the bucket. </param> <param name="key"> The object key. </param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.OpenStreamAsync(Amazon.S3.Transfer.TransferUtilityOpenStreamRequest,System.Threading.CancellationToken)"> <summary> Returns a stream to read the contents from Amazon S3 as specified by the <c>TransferUtilityOpenStreamRequest</c>. The caller of this method is responsible for closing the stream. </summary> <param name="request"> Contains all the parameters required for the OpenStream operation. </param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.UploadDirectory(System.String,System.String)"> <summary> Uploads files from a specified directory. The object key is derived from the file names inside the directory. For large uploads, the file will be divided and uploaded in parts using Amazon S3's multipart API. The parts will be reassembled as one object in Amazon S3. </summary> <remarks> <para> If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. </para> </remarks> <param name="directory"> The source directory, that is, the directory containing the files to upload. </param> <param name="bucketName"> The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. </param> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.UploadDirectory(System.String,System.String,System.String,System.IO.SearchOption)"> <summary> Uploads files from a specified directory. The object key is derived from the file names inside the directory. For large uploads, the file will be divided and uploaded in parts using Amazon S3's multipart API. The parts will be reassembled as one object in Amazon S3. </summary> <remarks> <para> If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. </para> </remarks> <param name="directory"> The source directory, that is, the directory containing the files to upload. </param> <param name="bucketName"> The target Amazon S3 bucket, that is, the name of the bucket to upload the files to. </param> <param name="searchPattern"> A pattern used to identify the files from the source directory to upload. </param> <param name="searchOption"> A search option that specifies whether to recursively search for files to upload in subdirectories. </param> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.UploadDirectory(Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest)"> <summary> Uploads files from a specified directory. The object key is derived from the file names inside the directory. For large uploads, the file will be divided and uploaded in parts using Amazon S3's multipart API. The parts will be reassembled as one object in Amazon S3. </summary> <remarks> <para> If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. </para> </remarks> <param name="request"> The request that contains all the parameters required to upload a directory. </param> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.Upload(System.String,System.String)"> <summary> Uploads the specified file. The object key is derived from the file's name. Multiple threads are used to read the file and perform multiple uploads in parallel. For large uploads, the file will be divided and uploaded in parts using Amazon S3's multipart API. The parts will be reassembled as one object in Amazon S3. </summary> <remarks> <para> If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. </para> </remarks> <param name="filePath"> The file path of the file to upload. </param> <param name="bucketName"> The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. </param> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.Upload(System.String,System.String,System.String)"> <summary> Uploads the specified file. Multiple threads are used to read the file and perform multiple uploads in parallel. For large uploads, the file will be divided and uploaded in parts using Amazon S3's multipart API. The parts will be reassembled as one object in Amazon S3. </summary> <remarks> <para> If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. </para> </remarks> <param name="filePath"> The file path of the file to upload. </param> <param name="bucketName"> The target Amazon S3 bucket, that is, the name of the bucket to upload the file to. </param> <param name="key"> The key under which the Amazon S3 object is stored. </param> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.Upload(System.IO.Stream,System.String,System.String)"> <summary> Uploads the contents of the specified stream. For large uploads, the file will be divided and uploaded in parts using Amazon S3's multipart API. The parts will be reassembled as one object in Amazon S3. </summary> <remarks> <para> If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. </para> </remarks> <param name="stream"> The stream to read to obtain the content to upload. </param> <param name="bucketName"> The target Amazon S3 bucket, that is, the name of the bucket to upload the stream to. </param> <param name="key"> The key under which the Amazon S3 object is stored. </param> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.Upload(Amazon.S3.Transfer.TransferUtilityUploadRequest)"> <summary> Uploads the file or stream specified by the request. To track the progress of the upload, add an event listener to the request's <c>UploadProgressEvent</c>. For large uploads, the file will be divided and uploaded in parts using Amazon S3's multipart API. The parts will be reassembled as one object in Amazon S3. </summary> <remarks> <para> If you are uploading large files, TransferUtility will use multipart upload to fulfill the request. If a multipart upload is interrupted, TransferUtility will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), TransferUtility will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke TransferUtility.AbortMultipartUploads() to abort the incomplete multipart uploads. </para> </remarks> <param name="request"> Contains all the parameters required to upload to Amazon S3. </param> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.OpenStream(System.String,System.String)"> <summary> Returns a stream from which the caller can read the content from the specified Amazon S3 bucket and key. The caller of this method is responsible for closing the stream. </summary> <param name="bucketName"> The name of the bucket. </param> <param name="key"> The object key. </param> <returns> A stream of the contents from the specified Amazon S3 and key. </returns> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.OpenStream(Amazon.S3.Transfer.TransferUtilityOpenStreamRequest)"> <summary> Returns a stream to read the contents from Amazon S3 as specified by the <c>TransferUtilityOpenStreamRequest</c>. The caller of this method is responsible for closing the stream. </summary> <param name="request"> Contains all the parameters required to open a stream to an S3 object. </param> <returns> A stream of the contents from Amazon S3. </returns> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.Download(System.String,System.String,System.String)"> <summary> Downloads the content from Amazon S3 and writes it to the specified file. </summary> <param name="filePath"> The file path where the content from Amazon S3 will be written to. </param> <param name="bucketName"> The name of the bucket containing the Amazon S3 object to download. </param> <param name="key"> The key under which the Amazon S3 object is stored. </param> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.Download(Amazon.S3.Transfer.TransferUtilityDownloadRequest)"> <summary> Downloads the content from Amazon S3 and writes it to the specified file. If the key is not specified in the request parameter, the file name will used as the key name. </summary> <param name="request"> Contains all the parameters required to download an Amazon S3 object. </param> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.DownloadDirectory(System.String,System.String,System.String)"> <summary> Downloads the objects in Amazon S3 that have a key that starts with the value specified by <c>s3Directory</c>. </summary> <param name="bucketName"> The name of the bucket containing the Amazon S3 objects to download. </param> <param name="s3Directory"> The directory in Amazon S3 to download. </param> <param name="localDirectory"> The local directory to download the objects to. </param> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.DownloadDirectory(Amazon.S3.Transfer.TransferUtilityDownloadDirectoryRequest)"> <summary> Downloads the objects in Amazon S3 that have a key that starts with the value specified by the <c>S3Directory</c> property of the passed in <c>TransferUtilityDownloadDirectoryRequest</c> object. </summary> <param name="request"> Contains all the parameters required to download objects from Amazon S3 into a local directory. </param> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.AbortMultipartUploads(System.String,System.DateTime)"> <summary> Aborts the multipart uploads that were initiated before the specified date. </summary> <param name="bucketName"> The name of the bucket containing multipart uploads. </param> <param name="initiatedDate"> The date before which the multipart uploads were initiated. </param> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.#ctor"> <summary> Constructs a new <see cref="T:Amazon.S3.Transfer.TransferUtility"/> class. </summary> <remarks> <para> If a Timeout needs to be specified, use the constructor which takes an <see cref="T:Amazon.S3.AmazonS3Client"/> as a paramater. Use an instance of <see cref="T:Amazon.S3.AmazonS3Client"/> constructed with an <see cref="T:Amazon.S3.AmazonS3Config"/> object with the Timeout specified. </para> </remarks> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs a new <see cref="T:Amazon.S3.Transfer.TransferUtility"/> class. </summary> <param name="region"> The region to configure the transfer utility for. </param> <remarks> <para> If a Timeout needs to be specified, use the constructor which takes an <see cref="T:Amazon.S3.AmazonS3Client"/> as a paramater. Use an instance of <see cref="T:Amazon.S3.AmazonS3Client"/> constructed with an <see cref="T:Amazon.S3.AmazonS3Config"/> object with the Timeout specified. </para> </remarks> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.#ctor(Amazon.S3.Transfer.TransferUtilityConfig)"> <summary> Constructs a new <see cref="T:Amazon.S3.Transfer.TransferUtility"/> class. </summary> <param name="config"> Specifies advanced configuration settings for <see cref="T:Amazon.S3.Transfer.TransferUtility"/>. </param> <remarks> </remarks> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.#ctor(System.String,System.String)"> <summary> Constructs a new <see cref="T:Amazon.S3.Transfer.TransferUtility"/> class. </summary> <param name="awsAccessKeyId"> The AWS Access Key ID. </param> <param name="awsSecretAccessKey"> The AWS Secret Access Key. </param> <remarks> <para> If a Timeout needs to be specified, use the constructor which takes an <see cref="T:Amazon.S3.AmazonS3Client"/> as a paramater. Use an instance of <see cref="T:Amazon.S3.AmazonS3Client"/> constructed with an <see cref="T:Amazon.S3.AmazonS3Config"/> object with the Timeout specified. </para> </remarks> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs a new <see cref="T:Amazon.S3.Transfer.TransferUtility"/> class. </summary> <param name="awsAccessKeyId"> The AWS Access Key ID. </param> <param name="awsSecretAccessKey"> The AWS Secret Access Key. </param> <param name="region"> The region to configure the transfer utility for. </param> <remarks> <para> If a Timeout needs to be specified, use the constructor which takes an <see cref="T:Amazon.S3.AmazonS3Client"/> as a paramater. Use an instance of <see cref="T:Amazon.S3.AmazonS3Client"/> constructed with an <see cref="T:Amazon.S3.AmazonS3Config"/> object with the Timeout specified. </para> </remarks> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.#ctor(System.String,System.String,Amazon.S3.Transfer.TransferUtilityConfig)"> <summary> Constructs a new instance of the <see cref="T:Amazon.S3.Transfer.TransferUtility"/> class. </summary> <param name="awsAccessKeyId"> The AWS Access Key ID. </param> <param name="awsSecretAccessKey"> The AWS Secret Access Key. </param> <param name="config"> Specifies advanced settings. </param> <remarks> <para> If a Timeout needs to be specified, use the constructor which takes an <see cref="T:Amazon.S3.AmazonS3Client"/> as a paramater. Use an instance of <see cref="T:Amazon.S3.AmazonS3Client"/> constructed with an <see cref="T:Amazon.S3.AmazonS3Config"/> object with the Timeout specified. </para> </remarks> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.#ctor(System.String,System.String,Amazon.RegionEndpoint,Amazon.S3.Transfer.TransferUtilityConfig)"> <summary> Constructs a new instance of the <see cref="T:Amazon.S3.Transfer.TransferUtility"/> class. </summary> <param name="awsAccessKeyId"> The AWS Access Key ID. </param> <param name="awsSecretAccessKey"> The AWS Secret Access Key. </param> <param name="region"> The region to configure the transfer utility for. </param> <param name="config"> Specifies advanced settings. </param> <remarks> <para> If a Timeout needs to be specified, use the constructor which takes an <see cref="T:Amazon.S3.AmazonS3Client"/> as a paramater. Use an instance of <see cref="T:Amazon.S3.AmazonS3Client"/> constructed with an <see cref="T:Amazon.S3.AmazonS3Config"/> object with the Timeout specified. </para> </remarks> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.#ctor(Amazon.S3.IAmazonS3)"> <summary> Constructs a new instance of the <see cref="T:Amazon.S3.Transfer.TransferUtility"/> class. </summary> <param name="s3Client"> The Amazon S3 client. </param> <remarks> <para> If a Timeout needs to be specified, use the constructor which takes an <see cref="T:Amazon.S3.AmazonS3Client"/> as a paramater. Use an instance of <see cref="T:Amazon.S3.AmazonS3Client"/> constructed with an <see cref="T:Amazon.S3.AmazonS3Config"/> object with the Timeout specified. </para> </remarks> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.#ctor(Amazon.S3.IAmazonS3,Amazon.S3.Transfer.TransferUtilityConfig)"> <summary> Initializes a new instance of the <see cref="T:Amazon.S3.Transfer.TransferUtility"/> class. </summary> <param name="s3Client"> The Amazon S3 client. </param> <param name="config"> Specifies advanced configuration settings for <see cref="T:Amazon.S3.Transfer.TransferUtility"/>. </param> <remarks> <para> If a Timeout needs to be specified, use the constructor which takes an <see cref="T:Amazon.S3.AmazonS3Client"/> as a paramater. Use an instance of <see cref="T:Amazon.S3.AmazonS3Client"/> constructed with an <see cref="T:Amazon.S3.AmazonS3Config"/> object with the Timeout specified. </para> </remarks> </member> <member name="M:Amazon.S3.Transfer.TransferUtility.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.S3.Transfer.TransferUtility.Dispose"> <summary> Disposes of all managed and unmanaged resources. </summary> </member> <member name="P:Amazon.S3.Transfer.TransferUtility.S3Client"> <summary> Gets the Amazon S3 client used for making calls into Amazon S3. </summary> <value> The Amazon S3 client used for making calls into Amazon S3. </value> </member> <member name="T:Amazon.SecurityToken.AmazonSecurityTokenServiceClient"> <summary> Implementation for accessing SecurityTokenService AWS Security Token Service <para> The AWS Security Token Service (STS) is a web service that enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more detailed information about using this service, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary Security Credentials</a>. </para> <note> As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to STS. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services page</a>. </note> <para> For information about setting up signatures and authorization through the API, go to <a href="http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html" target="_blank">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information about the Query API, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html" target="_blank">Making Query Requests</a> in <i>Using IAM</i>. For information about using security tokens with other AWS products, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html">AWS Services That Work with IAM</a> in the <i>Using IAM</i>. </para> <para> If you're new to AWS and need additional technical information about a specific AWS product, you can find the product's technical documentation at <a href="http://aws.amazon.com/documentation/" target="_blank">http://aws.amazon.com/documentation/</a>. </para> <para> <b>Endpoints</b> </para> <para> The AWS Security Token Service (STS) has a default endpoint of https://sts.amazonaws.com that maps to the US East (N. Virginia) region. Additional regions are available, but must first be activated in the AWS Management Console before you can use a different region's endpoint. For more information about activating a region for STS see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating STS in a New Region</a> in the <i>Using IAM</i>. </para> <para> For information about STS endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#sts_region">Regions and Endpoints</a> in the <i>AWS General Reference</i>. </para> <para> <b>Recording API requests</b> </para> <para> STS supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to STS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">AWS CloudTrail User Guide</a>. </para> </summary> </member> <member name="T:Amazon.SecurityToken.IAmazonSecurityTokenService"> <summary> Interface for accessing SecurityTokenService AWS Security Token Service <para> The AWS Security Token Service (STS) is a web service that enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more detailed information about using this service, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary Security Credentials</a>. </para> <note> As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to STS. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services page</a>. </note> <para> For information about setting up signatures and authorization through the API, go to <a href="http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html" target="_blank">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information about the Query API, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html" target="_blank">Making Query Requests</a> in <i>Using IAM</i>. For information about using security tokens with other AWS products, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html">AWS Services That Work with IAM</a> in the <i>Using IAM</i>. </para> <para> If you're new to AWS and need additional technical information about a specific AWS product, you can find the product's technical documentation at <a href="http://aws.amazon.com/documentation/" target="_blank">http://aws.amazon.com/documentation/</a>. </para> <para> <b>Endpoints</b> </para> <para> The AWS Security Token Service (STS) has a default endpoint of https://sts.amazonaws.com that maps to the US East (N. Virginia) region. Additional regions are available, but must first be activated in the AWS Management Console before you can use a different region's endpoint. For more information about activating a region for STS see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating STS in a New Region</a> in the <i>Using IAM</i>. </para> <para> For information about STS endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#sts_region">Regions and Endpoints</a> in the <i>AWS General Reference</i>. </para> <para> <b>Recording API requests</b> </para> <para> STS supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to STS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">AWS CloudTrail User Guide</a>. </para> </summary> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.AssumeRole(Amazon.SecurityToken.Model.AssumeRoleRequest)"> <summary> Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) that you can use to access AWS resources that you might not normally have access to. Typically, you use <code>AssumeRole</code> for cross-account access or federation. <para> <b>Important:</b> You cannot call <code>AssumeRole</code> by using AWS account credentials; access will be denied. You must use IAM user credentials or temporary security credentials to call <code>AssumeRole</code>. </para> <para> For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">IAM Roles (Delegation and Federation)</a> in the <i>Using IAM</i>. </para> <para> For federation, you can, for example, grant single sign-on access to the AWS Management Console. If you already have an identity and authentication system in your corporate network, you don't have to recreate user identities in AWS in order to grant those user identities access to AWS. Instead, after a user has been authenticated, you call <code>AssumeRole</code> (and specify the role with the appropriate permissions) to get temporary security credentials for that user. With those temporary security credentials, you construct a sign-in URL that users can use to access the console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html#sts-introduction">Common Scenarios for Temporary Credentials</a> in the <i>Using IAM</i>. </para> <para> The temporary security credentials are valid for the duration that you specified when calling <code>AssumeRole</code>, which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). The default is 1 hour. </para> <para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>Using IAM</i>. </para> <para> To assume a role, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. You must also have a policy that allows you to call <code>sts:AssumeRole</code>. </para> <para> <b>Using MFA with AssumeRole</b> </para> <para> You can optionally include multi-factor authentication (MFA) information when you call <code>AssumeRole</code>. This is useful for cross-account scenarios in which you want to make sure that the user who is assuming the role has been authenticated using an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication; if the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example. </para> <para> <code>"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}</code> </para> <para> For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html">Configuring MFA-Protected API Access</a> in the <i>Using IAM</i> guide. </para> <para> To use MFA with <code>AssumeRole</code>, you pass values for the <code>SerialNumber</code> and <code>TokenCode</code> parameters. The <code>SerialNumber</code> value identifies the user's hardware or virtual MFA device. The <code>TokenCode</code> is the time-based one-time password (TOTP) that the MFA devices produces. </para> <member name="RoleArn" target="arnType"/> <member name="RoleSessionName" target="userNameType"/> <member name="Policy" target="sessionPolicyDocumentType"/> <member name="DurationSeconds" target="roleDurationSecondsType"/> <member name="ExternalId" target="externalIdType"/> </summary> <param name="request">Container for the necessary parameters to execute the AssumeRole service method.</param> <returns>The response from the AssumeRole service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. </exception> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to create temporary credentials. The account administrator must activate STS in that region using the IAM Console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>Using IAM</i>. </exception> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.AssumeRoleAsync(Amazon.SecurityToken.Model.AssumeRoleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssumeRole operation. </summary> <param name="request">Container for the necessary parameters to execute the AssumeRole operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.AssumeRoleWithSAML(Amazon.SecurityToken.Model.AssumeRoleWithSAMLRequest)"> <summary> Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. <para> The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services. The credentials are valid for the duration that you specified when calling <code>AssumeRoleWithSAML</code>, which can be up to 3600 seconds (1 hour) or until the time specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value, whichever is shorter. </para> <note>The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified. </note> <para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>Using IAM</i>. </para> <para> Before your application can call <code>AssumeRoleWithSAML</code>, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider, and create an IAM role that specifies this SAML provider in its trust policy. </para> <para> Calling <code>AssumeRoleWithSAML</code> does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider. </para> <para> For more information, see the following resources: </para> <ul> <li><a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About SAML 2.0-based Federation</a> in the <i>Using IAM</i>. </li> <li> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html">Creating SAML Identity Providers</a> in the <i>Using IAM</i>. </li> <li> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml_relying-party.html">Configuring a Relying Party and Claims</a> in the <i>Using IAM</i>. </li> <li> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_saml.html">Creating a Role for SAML 2.0 Federation</a> in the <i>Using IAM</i>. </li> </ul> <member name="RoleArn" target="arnType"/> <member name="SAMLAssertion" target="SAMLAssertionType"/> <member name="Policy" target="sessionPolicyDocumentType"/> <member name="DurationSeconds" target="roleDurationSecondsType"/> </summary> <param name="request">Container for the necessary parameters to execute the AssumeRoleWithSAML service method.</param> <returns>The response from the AssumeRoleWithSAML service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.ExpiredTokenException"> The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request. </exception> <exception cref="T:Amazon.SecurityToken.Model.IDPRejectedClaimException"> The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid. <para> If this error is returned for the <code>AssumeRoleWithWebIdentity</code> operation, it can also mean that the claim has expired or has been explicitly revoked. </para> </exception> <exception cref="T:Amazon.SecurityToken.Model.InvalidIdentityTokenException"> The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request. </exception> <exception cref="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. </exception> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to create temporary credentials. The account administrator must activate STS in that region using the IAM Console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>Using IAM</i>. </exception> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.AssumeRoleWithSAMLAsync(Amazon.SecurityToken.Model.AssumeRoleWithSAMLRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssumeRoleWithSAML operation. </summary> <param name="request">Container for the necessary parameters to execute the AssumeRoleWithSAML operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.AssumeRoleWithWebIdentity(Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityRequest)"> <summary> Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider. <note> <para> For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the <a href="http://aws.amazon.com/sdkforios/">AWS SDK for iOS</a> and the <a href="http://aws.amazon.com/sdkforandroid/">AWS SDK for Android</a> to uniquely identify a user and supply the user with a consistent identity throughout the lifetime of an application. </para> <para> To learn more about Amazon Cognito, see <a href="http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-auth.html#d0e840">Amazon Cognito Overview</a> in the <i>AWS SDK for Android Developer Guide</i> guide and <a href="http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-auth.html#d0e664">Amazon Cognito Overview</a> in the <i>AWS SDK for iOS Developer Guide</i>. </para> </note> <para> Calling <code>AssumeRoleWithWebIdentity</code> does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application, and without deploying server-based proxy services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. </para> <para> The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service APIs. The credentials are valid for the duration that you specified when calling <code>AssumeRoleWithWebIdentity</code>, which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the temporary security credentials are valid for 1 hour. </para> <para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>Using IAM</i>. </para> <para> Before your application can call <code>AssumeRoleWithWebIdentity</code>, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy. </para> <para> For more information about how to use web identity federation and the <code>AssumeRoleWithWebIdentity</code> API, see the following resources: </para> <ul> <li> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual">Using Web Identity Federation APIs for Mobile Apps</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity">Federation Through a Web-based Identity Provider</a>. </li> <li><a href="https://web-identity-federation-playground.s3.amazonaws.com/index.html"> Web Identity Federation Playground</a>. This interactive website lets you walk through the process of authenticating via Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to AWS. </li> <li><a href="http://aws.amazon.com/sdkforios/">AWS SDK for iOS</a> and <a href="http://aws.amazon.com/sdkforandroid/">AWS SDK for Android</a>. These toolkits contain sample apps that show how to invoke the identity providers, and then how to use the information from these providers to get and use temporary security credentials. </li> <li><a href="http://aws.amazon.com/articles/4617974389850313">Web Identity Federation with Mobile Applications</a>. This article discusses web identity federation and shows an example of how to use web identity federation to get access to content in Amazon S3. </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the AssumeRoleWithWebIdentity service method.</param> <returns>The response from the AssumeRoleWithWebIdentity service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.ExpiredTokenException"> The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request. </exception> <exception cref="T:Amazon.SecurityToken.Model.IDPCommunicationErrorException"> The request could not be fulfilled because the non-AWS identity provider (IDP) that was asked to verify the incoming identity token could not be reached. This is often a transient error caused by network conditions. Retry the request a limited number of times so that you don't exceed the request rate. If the error persists, the non-AWS identity provider might be down or not responding. </exception> <exception cref="T:Amazon.SecurityToken.Model.IDPRejectedClaimException"> The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid. <para> If this error is returned for the <code>AssumeRoleWithWebIdentity</code> operation, it can also mean that the claim has expired or has been explicitly revoked. </para> </exception> <exception cref="T:Amazon.SecurityToken.Model.InvalidIdentityTokenException"> The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request. </exception> <exception cref="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. </exception> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to create temporary credentials. The account administrator must activate STS in that region using the IAM Console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>Using IAM</i>. </exception> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.AssumeRoleWithWebIdentityAsync(Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssumeRoleWithWebIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the AssumeRoleWithWebIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.DecodeAuthorizationMessage(Amazon.SecurityToken.Model.DecodeAuthorizationMessageRequest)"> <summary> Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request. <para> For example, if a user is not authorized to perform an action that he or she has requested, the request returns a <code>Client.UnauthorizedOperation</code> response (an HTTP 403 response). Some AWS actions additionally return an encoded message that can provide details about this authorization failure. </para> <note> Only certain AWS actions return an encoded authorization message. The documentation for an individual action indicates whether that action returns an encoded message in addition to returning an HTTP code. </note> <para> The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the action should not see. To decode an authorization status message, a user must be granted permissions via an IAM policy to request the <code>DecodeAuthorizationMessage</code> (<code>sts:DecodeAuthorizationMessage</code>) action. </para> <para> The decoded message includes the following type of information: </para> <ul> <li>Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow">Determining Whether a Request is Allowed or Denied</a> in the <i>Using IAM</i>. </li> <li>The principal who made the request.</li> <li>The requested action.</li> <li>The requested resource.</li> <li>The values of condition keys in the context of the user's request.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DecodeAuthorizationMessage service method.</param> <returns>The response from the DecodeAuthorizationMessage service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.InvalidAuthorizationMessageException"> The error returned if the message passed to <code>DecodeAuthorizationMessage</code> was invalid. This can happen if the token contains invalid characters, such as linebreaks. </exception> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.DecodeAuthorizationMessageAsync(Amazon.SecurityToken.Model.DecodeAuthorizationMessageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DecodeAuthorizationMessage operation. </summary> <param name="request">Container for the necessary parameters to execute the DecodeAuthorizationMessage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.GetFederationToken(Amazon.SecurityToken.Model.GetFederationTokenRequest)"> <summary> Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. Because you must call the <code>GetFederationToken</code> action using the long-term security credentials of an IAM user, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. <note> <para> If you are creating a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider, we recommend that you use <a href="http://aws.amazon.com/cognito/">Amazon Cognito</a> or <code>AssumeRoleWithWebIdentity</code>. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity">Federation Through a Web-based Identity Provider</a>. </para> </note> <para> The <code>GetFederationToken</code> action must be called by using the long-term AWS security credentials of an IAM user. You can also call <code>GetFederationToken</code> using the security credentials of an AWS account (root), but this is not recommended. Instead, we recommend that you create an IAM user for the purpose of the proxy application and then attach a policy to the IAM user that limits federated users to only the actions and resources they need access to. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html">IAM Best Practices</a> in the <i>Using IAM</i>. </para> <para> The temporary security credentials that are obtained by using the long-term credentials of an IAM user are valid for the specified duration, between 900 seconds (15 minutes) and 129600 seconds (36 hours). Temporary credentials that are obtained by using AWS account (root) credentials have a maximum duration of 3600 seconds (1 hour) </para> <para> <b>Permissions</b> </para> <para> The permissions for the temporary security credentials returned by <code>GetFederationToken</code> are determined by a combination of the following: </para> <ul> <li>The policy or policies that are attached to the IAM user whose credentials are used to call <code>GetFederationToken</code>.</li> <li>The policy that is passed as a parameter in the call.</li> </ul> <para> The passed policy is attached to the temporary security credentials that result from the <code>GetFederationToken</code> API call--that is, to the <i>federated user</i>. When the federated user makes an AWS request, AWS evaluates the policy attached to the federated user in combination with the policy or policies attached to the IAM user whose credentials were used to call <code>GetFederationToken</code>. AWS allows the federated user's request only when both the federated user <i><b>and</b></i> the IAM user are explicitly allowed to perform the requested action. The passed policy cannot grant more permissions than those that are defined in the IAM user policy. </para> <para> A typical use case is that the permissions of the IAM user whose credentials are used to call <code>GetFederationToken</code> are designed to allow access to all the actions and resources that any federated user will need. Then, for individual users, you pass a policy to the operation that scopes down the permissions to a level that's appropriate to that individual user, using a policy that allows only a subset of permissions that are granted to the IAM user. </para> <para> If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource. </para> <para> For more information about how permissions work, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_getfederationtoken.html">Permissions for GetFederationToken</a>. For information about using <code>GetFederationToken</code> to create temporary security credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken">GetFederationToken—Federation Through a Custom Identity Broker</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetFederationToken service method.</param> <returns>The response from the GetFederationToken service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. </exception> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to create temporary credentials. The account administrator must activate STS in that region using the IAM Console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>Using IAM</i>. </exception> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.GetFederationTokenAsync(Amazon.SecurityToken.Model.GetFederationTokenRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetFederationToken operation. </summary> <param name="request">Container for the necessary parameters to execute the GetFederationToken operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.GetSessionToken"> <summary> Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 <code>StopInstances</code>. MFA-enabled IAM users would need to call <code>GetSessionToken</code> and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. <para> The <code>GetSessionToken</code> action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, between 900 seconds (15 minutes) and 129600 seconds (36 hours); credentials that are created by using account credentials have a maximum duration of 3600 seconds (1 hour). </para> <note> <para> We recommend that you do not call <code>GetSessionToken</code> with root account credentials. Instead, follow our <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users">best practices</a> by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS. </para> </note> <para> The permissions associated with the temporary security credentials returned by <code>GetSessionToken</code> are based on the permissions associated with account or IAM user whose credentials are used to call the action. If <code>GetSessionToken</code> is called using root account credentials, the temporary credentials have root account permissions. Similarly, if <code>GetSessionToken</code> is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. </para> <para> For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken">Temporary Credentials for Users in Untrusted Environments</a> in the <i>Using IAM</i>. </para> </summary> <returns>The response from the GetSessionToken service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to create temporary credentials. The account administrator must activate STS in that region using the IAM Console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>Using IAM</i>. </exception> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.GetSessionToken(Amazon.SecurityToken.Model.GetSessionTokenRequest)"> <summary> Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 <code>StopInstances</code>. MFA-enabled IAM users would need to call <code>GetSessionToken</code> and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. <para> The <code>GetSessionToken</code> action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, between 900 seconds (15 minutes) and 129600 seconds (36 hours); credentials that are created by using account credentials have a maximum duration of 3600 seconds (1 hour). </para> <note> <para> We recommend that you do not call <code>GetSessionToken</code> with root account credentials. Instead, follow our <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users">best practices</a> by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS. </para> </note> <para> The permissions associated with the temporary security credentials returned by <code>GetSessionToken</code> are based on the permissions associated with account or IAM user whose credentials are used to call the action. If <code>GetSessionToken</code> is called using root account credentials, the temporary credentials have root account permissions. Similarly, if <code>GetSessionToken</code> is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. </para> <para> For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken">Temporary Credentials for Users in Untrusted Environments</a> in the <i>Using IAM</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetSessionToken service method.</param> <returns>The response from the GetSessionToken service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to create temporary credentials. The account administrator must activate STS in that region using the IAM Console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>Using IAM</i>. </exception> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.GetSessionTokenAsync(Amazon.SecurityToken.Model.GetSessionTokenRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSessionToken operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSessionToken operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor"> <summary> Constructs AmazonSecurityTokenServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonSecurityTokenServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(Amazon.SecurityToken.AmazonSecurityTokenServiceConfig)"> <summary> Constructs AmazonSecurityTokenServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonSecurityTokenServiceClient Configuration Object</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.SecurityToken.AmazonSecurityTokenServiceConfig)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Credentials and an AmazonSecurityTokenServiceClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonSecurityTokenServiceClient Configuration Object</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(System.String,System.String,Amazon.SecurityToken.AmazonSecurityTokenServiceConfig)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSecurityTokenServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonSecurityTokenServiceClient Configuration Object</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(System.String,System.String,System.String,Amazon.SecurityToken.AmazonSecurityTokenServiceConfig)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSecurityTokenServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonSecurityTokenServiceClient Configuration Object</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.AssumeRole(Amazon.SecurityToken.Model.AssumeRoleRequest)"> <summary> Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) that you can use to access AWS resources that you might not normally have access to. Typically, you use <code>AssumeRole</code> for cross-account access or federation. <para> <b>Important:</b> You cannot call <code>AssumeRole</code> by using AWS account credentials; access will be denied. You must use IAM user credentials or temporary security credentials to call <code>AssumeRole</code>. </para> <para> For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">IAM Roles (Delegation and Federation)</a> in the <i>Using IAM</i>. </para> <para> For federation, you can, for example, grant single sign-on access to the AWS Management Console. If you already have an identity and authentication system in your corporate network, you don't have to recreate user identities in AWS in order to grant those user identities access to AWS. Instead, after a user has been authenticated, you call <code>AssumeRole</code> (and specify the role with the appropriate permissions) to get temporary security credentials for that user. With those temporary security credentials, you construct a sign-in URL that users can use to access the console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html#sts-introduction">Common Scenarios for Temporary Credentials</a> in the <i>Using IAM</i>. </para> <para> The temporary security credentials are valid for the duration that you specified when calling <code>AssumeRole</code>, which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). The default is 1 hour. </para> <para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>Using IAM</i>. </para> <para> To assume a role, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. You must also have a policy that allows you to call <code>sts:AssumeRole</code>. </para> <para> <b>Using MFA with AssumeRole</b> </para> <para> You can optionally include multi-factor authentication (MFA) information when you call <code>AssumeRole</code>. This is useful for cross-account scenarios in which you want to make sure that the user who is assuming the role has been authenticated using an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication; if the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example. </para> <para> <code>"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}</code> </para> <para> For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html">Configuring MFA-Protected API Access</a> in the <i>Using IAM</i> guide. </para> <para> To use MFA with <code>AssumeRole</code>, you pass values for the <code>SerialNumber</code> and <code>TokenCode</code> parameters. The <code>SerialNumber</code> value identifies the user's hardware or virtual MFA device. The <code>TokenCode</code> is the time-based one-time password (TOTP) that the MFA devices produces. </para> <member name="RoleArn" target="arnType"/> <member name="RoleSessionName" target="userNameType"/> <member name="Policy" target="sessionPolicyDocumentType"/> <member name="DurationSeconds" target="roleDurationSecondsType"/> <member name="ExternalId" target="externalIdType"/> </summary> <param name="request">Container for the necessary parameters to execute the AssumeRole service method.</param> <returns>The response from the AssumeRole service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. </exception> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to create temporary credentials. The account administrator must activate STS in that region using the IAM Console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>Using IAM</i>. </exception> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.AssumeRoleAsync(Amazon.SecurityToken.Model.AssumeRoleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssumeRole operation. </summary> <param name="request">Container for the necessary parameters to execute the AssumeRole operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.AssumeRoleWithSAML(Amazon.SecurityToken.Model.AssumeRoleWithSAMLRequest)"> <summary> Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. <para> The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services. The credentials are valid for the duration that you specified when calling <code>AssumeRoleWithSAML</code>, which can be up to 3600 seconds (1 hour) or until the time specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value, whichever is shorter. </para> <note>The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified. </note> <para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>Using IAM</i>. </para> <para> Before your application can call <code>AssumeRoleWithSAML</code>, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider, and create an IAM role that specifies this SAML provider in its trust policy. </para> <para> Calling <code>AssumeRoleWithSAML</code> does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider. </para> <para> For more information, see the following resources: </para> <ul> <li><a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About SAML 2.0-based Federation</a> in the <i>Using IAM</i>. </li> <li> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html">Creating SAML Identity Providers</a> in the <i>Using IAM</i>. </li> <li> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml_relying-party.html">Configuring a Relying Party and Claims</a> in the <i>Using IAM</i>. </li> <li> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_saml.html">Creating a Role for SAML 2.0 Federation</a> in the <i>Using IAM</i>. </li> </ul> <member name="RoleArn" target="arnType"/> <member name="SAMLAssertion" target="SAMLAssertionType"/> <member name="Policy" target="sessionPolicyDocumentType"/> <member name="DurationSeconds" target="roleDurationSecondsType"/> </summary> <param name="request">Container for the necessary parameters to execute the AssumeRoleWithSAML service method.</param> <returns>The response from the AssumeRoleWithSAML service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.ExpiredTokenException"> The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request. </exception> <exception cref="T:Amazon.SecurityToken.Model.IDPRejectedClaimException"> The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid. <para> If this error is returned for the <code>AssumeRoleWithWebIdentity</code> operation, it can also mean that the claim has expired or has been explicitly revoked. </para> </exception> <exception cref="T:Amazon.SecurityToken.Model.InvalidIdentityTokenException"> The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request. </exception> <exception cref="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. </exception> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to create temporary credentials. The account administrator must activate STS in that region using the IAM Console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>Using IAM</i>. </exception> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.AssumeRoleWithSAMLAsync(Amazon.SecurityToken.Model.AssumeRoleWithSAMLRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssumeRoleWithSAML operation. </summary> <param name="request">Container for the necessary parameters to execute the AssumeRoleWithSAML operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.AssumeRoleWithWebIdentity(Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityRequest)"> <summary> Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider. <note> <para> For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the <a href="http://aws.amazon.com/sdkforios/">AWS SDK for iOS</a> and the <a href="http://aws.amazon.com/sdkforandroid/">AWS SDK for Android</a> to uniquely identify a user and supply the user with a consistent identity throughout the lifetime of an application. </para> <para> To learn more about Amazon Cognito, see <a href="http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-auth.html#d0e840">Amazon Cognito Overview</a> in the <i>AWS SDK for Android Developer Guide</i> guide and <a href="http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-auth.html#d0e664">Amazon Cognito Overview</a> in the <i>AWS SDK for iOS Developer Guide</i>. </para> </note> <para> Calling <code>AssumeRoleWithWebIdentity</code> does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application, and without deploying server-based proxy services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. </para> <para> The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service APIs. The credentials are valid for the duration that you specified when calling <code>AssumeRoleWithWebIdentity</code>, which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the temporary security credentials are valid for 1 hour. </para> <para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>Using IAM</i>. </para> <para> Before your application can call <code>AssumeRoleWithWebIdentity</code>, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy. </para> <para> For more information about how to use web identity federation and the <code>AssumeRoleWithWebIdentity</code> API, see the following resources: </para> <ul> <li> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual">Using Web Identity Federation APIs for Mobile Apps</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity">Federation Through a Web-based Identity Provider</a>. </li> <li><a href="https://web-identity-federation-playground.s3.amazonaws.com/index.html"> Web Identity Federation Playground</a>. This interactive website lets you walk through the process of authenticating via Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to AWS. </li> <li><a href="http://aws.amazon.com/sdkforios/">AWS SDK for iOS</a> and <a href="http://aws.amazon.com/sdkforandroid/">AWS SDK for Android</a>. These toolkits contain sample apps that show how to invoke the identity providers, and then how to use the information from these providers to get and use temporary security credentials. </li> <li><a href="http://aws.amazon.com/articles/4617974389850313">Web Identity Federation with Mobile Applications</a>. This article discusses web identity federation and shows an example of how to use web identity federation to get access to content in Amazon S3. </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the AssumeRoleWithWebIdentity service method.</param> <returns>The response from the AssumeRoleWithWebIdentity service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.ExpiredTokenException"> The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request. </exception> <exception cref="T:Amazon.SecurityToken.Model.IDPCommunicationErrorException"> The request could not be fulfilled because the non-AWS identity provider (IDP) that was asked to verify the incoming identity token could not be reached. This is often a transient error caused by network conditions. Retry the request a limited number of times so that you don't exceed the request rate. If the error persists, the non-AWS identity provider might be down or not responding. </exception> <exception cref="T:Amazon.SecurityToken.Model.IDPRejectedClaimException"> The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid. <para> If this error is returned for the <code>AssumeRoleWithWebIdentity</code> operation, it can also mean that the claim has expired or has been explicitly revoked. </para> </exception> <exception cref="T:Amazon.SecurityToken.Model.InvalidIdentityTokenException"> The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request. </exception> <exception cref="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. </exception> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to create temporary credentials. The account administrator must activate STS in that region using the IAM Console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>Using IAM</i>. </exception> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.AssumeRoleWithWebIdentityAsync(Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssumeRoleWithWebIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the AssumeRoleWithWebIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.DecodeAuthorizationMessage(Amazon.SecurityToken.Model.DecodeAuthorizationMessageRequest)"> <summary> Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request. <para> For example, if a user is not authorized to perform an action that he or she has requested, the request returns a <code>Client.UnauthorizedOperation</code> response (an HTTP 403 response). Some AWS actions additionally return an encoded message that can provide details about this authorization failure. </para> <note> Only certain AWS actions return an encoded authorization message. The documentation for an individual action indicates whether that action returns an encoded message in addition to returning an HTTP code. </note> <para> The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the action should not see. To decode an authorization status message, a user must be granted permissions via an IAM policy to request the <code>DecodeAuthorizationMessage</code> (<code>sts:DecodeAuthorizationMessage</code>) action. </para> <para> The decoded message includes the following type of information: </para> <ul> <li>Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow">Determining Whether a Request is Allowed or Denied</a> in the <i>Using IAM</i>. </li> <li>The principal who made the request.</li> <li>The requested action.</li> <li>The requested resource.</li> <li>The values of condition keys in the context of the user's request.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DecodeAuthorizationMessage service method.</param> <returns>The response from the DecodeAuthorizationMessage service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.InvalidAuthorizationMessageException"> The error returned if the message passed to <code>DecodeAuthorizationMessage</code> was invalid. This can happen if the token contains invalid characters, such as linebreaks. </exception> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.DecodeAuthorizationMessageAsync(Amazon.SecurityToken.Model.DecodeAuthorizationMessageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DecodeAuthorizationMessage operation. </summary> <param name="request">Container for the necessary parameters to execute the DecodeAuthorizationMessage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.GetFederationToken(Amazon.SecurityToken.Model.GetFederationTokenRequest)"> <summary> Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. Because you must call the <code>GetFederationToken</code> action using the long-term security credentials of an IAM user, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. <note> <para> If you are creating a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider, we recommend that you use <a href="http://aws.amazon.com/cognito/">Amazon Cognito</a> or <code>AssumeRoleWithWebIdentity</code>. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity">Federation Through a Web-based Identity Provider</a>. </para> </note> <para> The <code>GetFederationToken</code> action must be called by using the long-term AWS security credentials of an IAM user. You can also call <code>GetFederationToken</code> using the security credentials of an AWS account (root), but this is not recommended. Instead, we recommend that you create an IAM user for the purpose of the proxy application and then attach a policy to the IAM user that limits federated users to only the actions and resources they need access to. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html">IAM Best Practices</a> in the <i>Using IAM</i>. </para> <para> The temporary security credentials that are obtained by using the long-term credentials of an IAM user are valid for the specified duration, between 900 seconds (15 minutes) and 129600 seconds (36 hours). Temporary credentials that are obtained by using AWS account (root) credentials have a maximum duration of 3600 seconds (1 hour) </para> <para> <b>Permissions</b> </para> <para> The permissions for the temporary security credentials returned by <code>GetFederationToken</code> are determined by a combination of the following: </para> <ul> <li>The policy or policies that are attached to the IAM user whose credentials are used to call <code>GetFederationToken</code>.</li> <li>The policy that is passed as a parameter in the call.</li> </ul> <para> The passed policy is attached to the temporary security credentials that result from the <code>GetFederationToken</code> API call--that is, to the <i>federated user</i>. When the federated user makes an AWS request, AWS evaluates the policy attached to the federated user in combination with the policy or policies attached to the IAM user whose credentials were used to call <code>GetFederationToken</code>. AWS allows the federated user's request only when both the federated user <i><b>and</b></i> the IAM user are explicitly allowed to perform the requested action. The passed policy cannot grant more permissions than those that are defined in the IAM user policy. </para> <para> A typical use case is that the permissions of the IAM user whose credentials are used to call <code>GetFederationToken</code> are designed to allow access to all the actions and resources that any federated user will need. Then, for individual users, you pass a policy to the operation that scopes down the permissions to a level that's appropriate to that individual user, using a policy that allows only a subset of permissions that are granted to the IAM user. </para> <para> If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource. </para> <para> For more information about how permissions work, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_getfederationtoken.html">Permissions for GetFederationToken</a>. For information about using <code>GetFederationToken</code> to create temporary security credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken">GetFederationToken—Federation Through a Custom Identity Broker</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetFederationToken service method.</param> <returns>The response from the GetFederationToken service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. </exception> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to create temporary credentials. The account administrator must activate STS in that region using the IAM Console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>Using IAM</i>. </exception> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.GetFederationTokenAsync(Amazon.SecurityToken.Model.GetFederationTokenRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetFederationToken operation. </summary> <param name="request">Container for the necessary parameters to execute the GetFederationToken operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.GetSessionToken"> <summary> Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 <code>StopInstances</code>. MFA-enabled IAM users would need to call <code>GetSessionToken</code> and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. <para> The <code>GetSessionToken</code> action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, between 900 seconds (15 minutes) and 129600 seconds (36 hours); credentials that are created by using account credentials have a maximum duration of 3600 seconds (1 hour). </para> <note> <para> We recommend that you do not call <code>GetSessionToken</code> with root account credentials. Instead, follow our <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users">best practices</a> by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS. </para> </note> <para> The permissions associated with the temporary security credentials returned by <code>GetSessionToken</code> are based on the permissions associated with account or IAM user whose credentials are used to call the action. If <code>GetSessionToken</code> is called using root account credentials, the temporary credentials have root account permissions. Similarly, if <code>GetSessionToken</code> is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. </para> <para> For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken">Temporary Credentials for Users in Untrusted Environments</a> in the <i>Using IAM</i>. </para> </summary> <returns>The response from the GetSessionToken service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to create temporary credentials. The account administrator must activate STS in that region using the IAM Console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>Using IAM</i>. </exception> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.GetSessionToken(Amazon.SecurityToken.Model.GetSessionTokenRequest)"> <summary> Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 <code>StopInstances</code>. MFA-enabled IAM users would need to call <code>GetSessionToken</code> and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. <para> The <code>GetSessionToken</code> action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, between 900 seconds (15 minutes) and 129600 seconds (36 hours); credentials that are created by using account credentials have a maximum duration of 3600 seconds (1 hour). </para> <note> <para> We recommend that you do not call <code>GetSessionToken</code> with root account credentials. Instead, follow our <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users">best practices</a> by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS. </para> </note> <para> The permissions associated with the temporary security credentials returned by <code>GetSessionToken</code> are based on the permissions associated with account or IAM user whose credentials are used to call the action. If <code>GetSessionToken</code> is called using root account credentials, the temporary credentials have root account permissions. Similarly, if <code>GetSessionToken</code> is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. </para> <para> For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken">Temporary Credentials for Users in Untrusted Environments</a> in the <i>Using IAM</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetSessionToken service method.</param> <returns>The response from the GetSessionToken service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to create temporary credentials. The account administrator must activate STS in that region using the IAM Console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>Using IAM</i>. </exception> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.GetSessionTokenAsync(Amazon.SecurityToken.Model.GetSessionTokenRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSessionToken operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSessionToken operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.SimpleDB.AmazonSimpleDBClient"> <summary> Implementation for accessing SimpleDB Amazon SimpleDB is a web service providing the core database functions of data indexing and querying in the cloud. By offloading the time and effort associated with building and operating a web-scale database, SimpleDB provides developers the freedom to focus on application development. <para> A traditional, clustered relational database requires a sizable upfront capital outlay, is complex to design, and often requires extensive and repetitive database administration. Amazon SimpleDB is dramatically simpler, requiring no schema, automatically indexing your data and providing a simple API for storage and access. This approach eliminates the administrative burden of data modeling, index maintenance, and performance tuning. Developers gain access to this functionality within Amazon's proven computing environment, are able to scale instantly, and pay only for what they use. </para> <para> Visit <a href="http://aws.amazon.com/simpledb/">http://aws.amazon.com/simpledb/</a> for more information. </para> </summary> </member> <member name="T:Amazon.SimpleDB.IAmazonSimpleDB"> <summary> Interface for accessing SimpleDB Amazon SimpleDB is a web service providing the core database functions of data indexing and querying in the cloud. By offloading the time and effort associated with building and operating a web-scale database, SimpleDB provides developers the freedom to focus on application development. <para> A traditional, clustered relational database requires a sizable upfront capital outlay, is complex to design, and often requires extensive and repetitive database administration. Amazon SimpleDB is dramatically simpler, requiring no schema, automatically indexing your data and providing a simple API for storage and access. This approach eliminates the administrative burden of data modeling, index maintenance, and performance tuning. Developers gain access to this functionality within Amazon's proven computing environment, are able to scale instantly, and pay only for what they use. </para> <para> Visit <a href="http://aws.amazon.com/simpledb/">http://aws.amazon.com/simpledb/</a> for more information. </para> </summary> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.BatchDeleteAttributes(Amazon.SimpleDB.Model.BatchDeleteAttributesRequest)"> <summary> Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies. This enables Amazon SimpleDB to optimize requests, which generally yields better throughput. <para> The following limitations are enforced for this operation: <ul> <li>1 MB request size</li> <li>25 item limit per BatchDeleteAttributes operation</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the BatchDeleteAttributes service method.</param> <returns>The response from the BatchDeleteAttributes service method, as returned by SimpleDB.</returns> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.BatchDeleteAttributesAsync(Amazon.SimpleDB.Model.BatchDeleteAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchDeleteAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchDeleteAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.BatchPutAttributes(Amazon.SimpleDB.Model.BatchPutAttributesRequest)"> <summary> The <code>BatchPutAttributes</code> operation creates or replaces attributes within one or more items. By using this operation, the client can perform multiple <a>PutAttribute</a> operation with a single call. This helps yield savings in round trips and latencies, enabling Amazon SimpleDB to optimize requests and generally produce better throughput. <para> The client may specify the item name with the <code>Item.X.ItemName</code> parameter. The client may specify new attributes using a combination of the <code>Item.X.Attribute.Y.Name</code> and <code>Item.X.Attribute.Y.Value</code> parameters. The client may specify the first attribute for the first item using the parameters <code>Item.0.Attribute.0.Name</code> and <code>Item.0.Attribute.0.Value</code>, and for the second attribute for the first item by the parameters <code>Item.0.Attribute.1.Name</code> and <code>Item.0.Attribute.1.Value</code>, and so on. </para> <para> Attributes are uniquely identified within an item by their name/value combination. For example, a single item can have the attributes <code>{ "first_name", "first_value" }</code> and <code>{ "first_name", "second_value" }</code>. However, it cannot have two attribute instances where both the <code>Item.X.Attribute.Y.Name</code> and <code>Item.X.Attribute.Y.Value</code> are the same. </para> <para> Optionally, the requester can supply the <code>Replace</code> parameter for each individual value. Setting this value to <code>true</code> will cause the new attribute values to replace the existing attribute values. For example, if an item <code>I</code> has the attributes <code>{ 'a', '1' }, { 'b', '2'}</code> and <code>{ 'b', '3' }</code> and the requester does a BatchPutAttributes of <code>{'I', 'b', '4' }</code> with the Replace parameter set to true, the final attributes of the item will be <code>{ 'a', '1' }</code> and <code>{ 'b', '4' }</code>, replacing the previous values of the 'b' attribute with the new value. </para> <important> This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method. This operation does not support conditions using <code>Expected.X.Name</code>, <code>Expected.X.Value</code>, or <code>Expected.X.Exists</code>. </important> <para> You can execute multiple <code>BatchPutAttributes</code> operations and other operations in parallel. However, large numbers of concurrent <code>BatchPutAttributes</code> calls can result in Service Unavailable (503) responses. </para> <para> The following limitations are enforced for this operation: <ul> <li>256 attribute name-value pairs per item</li> <li>1 MB request size</li> <li>1 billion attributes per domain</li> <li>10 GB of total user data storage per domain</li> <li>25 item limit per <code>BatchPutAttributes</code> operation</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the BatchPutAttributes service method.</param> <returns>The response from the BatchPutAttributes service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.DuplicateItemNameException"> The item name was specified more than once. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.SimpleDB.Model.MissingParameterException"> The request must contain the specified missing parameter. </exception> <exception cref="T:Amazon.SimpleDB.Model.NoSuchDomainException"> The specified domain does not exist. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberDomainAttributesExceededException"> Too many attributes in this domain. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberDomainBytesExceededException"> Too many bytes in this domain. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberItemAttributesExceededException"> Too many attributes in this item. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberSubmittedAttributesExceededException"> Too many attributes exist in a single call. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberSubmittedItemsExceededException"> Too many items exist in a single call. </exception> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.BatchPutAttributesAsync(Amazon.SimpleDB.Model.BatchPutAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchPutAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchPutAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.CreateDomain(Amazon.SimpleDB.Model.CreateDomainRequest)"> <summary> The <code>CreateDomain</code> operation creates a new domain. The domain name should be unique among the domains associated with the Access Key ID provided in the request. The <code>CreateDomain</code> operation may take 10 or more seconds to complete. <para> The client can create up to 100 domains per account. </para> <para> If the client requires additional domains, go to <a href="http://aws.amazon.com/contact-us/simpledb-limit-request/"> http://aws.amazon.com/contact-us/simpledb-limit-request/</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain service method.</param> <returns>The response from the CreateDomain service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.SimpleDB.Model.MissingParameterException"> The request must contain the specified missing parameter. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberDomainsExceededException"> Too many domains exist per this account. </exception> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.CreateDomainAsync(Amazon.SimpleDB.Model.CreateDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.DeleteAttributes(Amazon.SimpleDB.Model.DeleteAttributesRequest)"> <summary> Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is deleted. <para> <code>DeleteAttributes</code> is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response. </para> <para> Because Amazon SimpleDB makes multiple copies of item data and uses an eventual consistency update model, performing a <a>GetAttributes</a> or <a>Select</a> operation (read) immediately after a <code>DeleteAttributes</code> or <a>PutAttributes</a> operation (write) might not return updated item data. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAttributes service method.</param> <returns>The response from the DeleteAttributes service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.AttributeDoesNotExistException"> The specified attribute does not exist. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.SimpleDB.Model.MissingParameterException"> The request must contain the specified missing parameter. </exception> <exception cref="T:Amazon.SimpleDB.Model.NoSuchDomainException"> The specified domain does not exist. </exception> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.DeleteAttributesAsync(Amazon.SimpleDB.Model.DeleteAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.DeleteDomain(Amazon.SimpleDB.Model.DeleteDomainRequest)"> <summary> The <code>DeleteDomain</code> operation deletes a domain. Any items (and their attributes) in the domain are deleted as well. The <code>DeleteDomain</code> operation might take 10 or more seconds to complete. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain service method.</param> <returns>The response from the DeleteDomain service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.MissingParameterException"> The request must contain the specified missing parameter. </exception> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.DeleteDomainAsync(Amazon.SimpleDB.Model.DeleteDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.DomainMetadata(Amazon.SimpleDB.Model.DomainMetadataRequest)"> <summary> Returns information about the domain, including when the domain was created, the number of items and attributes in the domain, and the size of the attribute names and values. </summary> <param name="request">Container for the necessary parameters to execute the DomainMetadata service method.</param> <returns>The response from the DomainMetadata service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.MissingParameterException"> The request must contain the specified missing parameter. </exception> <exception cref="T:Amazon.SimpleDB.Model.NoSuchDomainException"> The specified domain does not exist. </exception> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.DomainMetadataAsync(Amazon.SimpleDB.Model.DomainMetadataRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DomainMetadata operation. </summary> <param name="request">Container for the necessary parameters to execute the DomainMetadata operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.GetAttributes(Amazon.SimpleDB.Model.GetAttributesRequest)"> <summary> Returns all of the attributes associated with the specified item. Optionally, the attributes returned can be limited to one or more attributes by specifying an attribute name parameter. <para> If the item does not exist on the replica that was accessed for this operation, an empty set is returned. The system does not return an error as it cannot guarantee the item does not exist on other replicas. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetAttributes service method.</param> <returns>The response from the GetAttributes service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.SimpleDB.Model.MissingParameterException"> The request must contain the specified missing parameter. </exception> <exception cref="T:Amazon.SimpleDB.Model.NoSuchDomainException"> The specified domain does not exist. </exception> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.GetAttributesAsync(Amazon.SimpleDB.Model.GetAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.ListDomains"> <summary> The <code>ListDomains</code> operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by <a href="#MaxNumberOfDomains">MaxNumberOfDomains</a>. A <a href="#NextToken">NextToken</a> is returned if there are more than <code>MaxNumberOfDomains</code> domains. Calling <code>ListDomains</code> successive times with the <code>NextToken</code> provided by the operation returns up to <code>MaxNumberOfDomains</code> more domain names with each successive operation call. </summary> <returns>The response from the ListDomains service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.InvalidNextTokenException"> The specified NextToken is not valid. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.ListDomains(Amazon.SimpleDB.Model.ListDomainsRequest)"> <summary> The <code>ListDomains</code> operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by <a href="#MaxNumberOfDomains">MaxNumberOfDomains</a>. A <a href="#NextToken">NextToken</a> is returned if there are more than <code>MaxNumberOfDomains</code> domains. Calling <code>ListDomains</code> successive times with the <code>NextToken</code> provided by the operation returns up to <code>MaxNumberOfDomains</code> more domain names with each successive operation call. </summary> <param name="request">Container for the necessary parameters to execute the ListDomains service method.</param> <returns>The response from the ListDomains service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.InvalidNextTokenException"> The specified NextToken is not valid. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.ListDomainsAsync(Amazon.SimpleDB.Model.ListDomainsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDomains operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDomains operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.PutAttributes(Amazon.SimpleDB.Model.PutAttributesRequest)"> <summary> The PutAttributes operation creates or replaces attributes in an item. The client may specify new attributes using a combination of the <code>Attribute.X.Name</code> and <code>Attribute.X.Value</code> parameters. The client specifies the first attribute by the parameters <code>Attribute.0.Name</code> and <code>Attribute.0.Value</code>, the second attribute by the parameters <code>Attribute.1.Name</code> and <code>Attribute.1.Value</code>, and so on. <para> Attributes are uniquely identified in an item by their name/value combination. For example, a single item can have the attributes <code>{ "first_name", "first_value" }</code> and <code>{ "first_name", second_value" }</code>. However, it cannot have two attribute instances where both the <code>Attribute.X.Name</code> and <code>Attribute.X.Value</code> are the same. </para> <para> Optionally, the requestor can supply the <code>Replace</code> parameter for each individual attribute. Setting this value to <code>true</code> causes the new attribute value to replace the existing attribute value(s). For example, if an item has the attributes <code>{ 'a', '1' }</code>, <code>{ 'b', '2'}</code> and <code>{ 'b', '3' }</code> and the requestor calls <code>PutAttributes</code> using the attributes <code>{ 'b', '4' }</code> with the <code>Replace</code> parameter set to true, the final attributes of the item are changed to <code>{ 'a', '1' }</code> and <code>{ 'b', '4' }</code>, which replaces the previous values of the 'b' attribute with the new value. </para> <para> You cannot specify an empty string as an attribute name. </para> <para> Because Amazon SimpleDB makes multiple copies of client data and uses an eventual consistency update model, an immediate <a>GetAttributes</a> or <a>Select</a> operation (read) immediately after a <a>PutAttributes</a> or <a>DeleteAttributes</a> operation (write) might not return the updated data. </para> <para> The following limitations are enforced for this operation: <ul> <li>256 total attribute name-value pairs per item</li> <li>One billion attributes per domain</li> <li>10 GB of total user data storage per domain</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the PutAttributes service method.</param> <returns>The response from the PutAttributes service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.AttributeDoesNotExistException"> The specified attribute does not exist. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.SimpleDB.Model.MissingParameterException"> The request must contain the specified missing parameter. </exception> <exception cref="T:Amazon.SimpleDB.Model.NoSuchDomainException"> The specified domain does not exist. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberDomainAttributesExceededException"> Too many attributes in this domain. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberDomainBytesExceededException"> Too many bytes in this domain. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberItemAttributesExceededException"> Too many attributes in this item. </exception> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.PutAttributesAsync(Amazon.SimpleDB.Model.PutAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the PutAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.Select(Amazon.SimpleDB.Model.SelectRequest)"> <summary> The <code>Select</code> operation returns a set of attributes for <code>ItemNames</code> that match the select expression. <code>Select</code> is similar to the standard SQL SELECT statement. <para> The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items returned per page to enforce this limit. For example, if the client asks to retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100 items and an appropriate <code>NextToken</code> so the client can access the next page of results. </para> <para> For information on how to construct select expressions, see Using Select to Create Amazon SimpleDB Queries in the Developer Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the Select service method.</param> <returns>The response from the Select service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.InvalidNextTokenException"> The specified NextToken is not valid. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidNumberPredicatesException"> Too many predicates exist in the query expression. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidNumberValueTestsException"> Too many predicates exist in the query expression. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidQueryExpressionException"> The specified query expression syntax is not valid. </exception> <exception cref="T:Amazon.SimpleDB.Model.MissingParameterException"> The request must contain the specified missing parameter. </exception> <exception cref="T:Amazon.SimpleDB.Model.NoSuchDomainException"> The specified domain does not exist. </exception> <exception cref="T:Amazon.SimpleDB.Model.RequestTimeoutException"> A timeout occurred when attempting to query the specified domain with specified query expression. </exception> <exception cref="T:Amazon.SimpleDB.Model.TooManyRequestedAttributesException"> Too many attributes requested. </exception> </member> <member name="M:Amazon.SimpleDB.IAmazonSimpleDB.SelectAsync(Amazon.SimpleDB.Model.SelectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Select operation. </summary> <param name="request">Container for the necessary parameters to execute the Select operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.#ctor"> <summary> Constructs AmazonSimpleDBClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleDBClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.#ctor(Amazon.SimpleDB.AmazonSimpleDBConfig)"> <summary> Constructs AmazonSimpleDBClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonSimpleDBClient Configuration Object</param> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonSimpleDBClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleDBClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.SimpleDB.AmazonSimpleDBConfig)"> <summary> Constructs AmazonSimpleDBClient with AWS Credentials and an AmazonSimpleDBClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonSimpleDBClient Configuration Object</param> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonSimpleDBClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleDBClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.#ctor(System.String,System.String,Amazon.SimpleDB.AmazonSimpleDBConfig)"> <summary> Constructs AmazonSimpleDBClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleDBClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonSimpleDBClient Configuration Object</param> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonSimpleDBClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleDBClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.#ctor(System.String,System.String,System.String,Amazon.SimpleDB.AmazonSimpleDBConfig)"> <summary> Constructs AmazonSimpleDBClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleDBClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonSimpleDBClient Configuration Object</param> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.BatchDeleteAttributes(Amazon.SimpleDB.Model.BatchDeleteAttributesRequest)"> <summary> Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies. This enables Amazon SimpleDB to optimize requests, which generally yields better throughput. <para> The following limitations are enforced for this operation: <ul> <li>1 MB request size</li> <li>25 item limit per BatchDeleteAttributes operation</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the BatchDeleteAttributes service method.</param> <returns>The response from the BatchDeleteAttributes service method, as returned by SimpleDB.</returns> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.BatchDeleteAttributesAsync(Amazon.SimpleDB.Model.BatchDeleteAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchDeleteAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchDeleteAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.BatchPutAttributes(Amazon.SimpleDB.Model.BatchPutAttributesRequest)"> <summary> The <code>BatchPutAttributes</code> operation creates or replaces attributes within one or more items. By using this operation, the client can perform multiple <a>PutAttribute</a> operation with a single call. This helps yield savings in round trips and latencies, enabling Amazon SimpleDB to optimize requests and generally produce better throughput. <para> The client may specify the item name with the <code>Item.X.ItemName</code> parameter. The client may specify new attributes using a combination of the <code>Item.X.Attribute.Y.Name</code> and <code>Item.X.Attribute.Y.Value</code> parameters. The client may specify the first attribute for the first item using the parameters <code>Item.0.Attribute.0.Name</code> and <code>Item.0.Attribute.0.Value</code>, and for the second attribute for the first item by the parameters <code>Item.0.Attribute.1.Name</code> and <code>Item.0.Attribute.1.Value</code>, and so on. </para> <para> Attributes are uniquely identified within an item by their name/value combination. For example, a single item can have the attributes <code>{ "first_name", "first_value" }</code> and <code>{ "first_name", "second_value" }</code>. However, it cannot have two attribute instances where both the <code>Item.X.Attribute.Y.Name</code> and <code>Item.X.Attribute.Y.Value</code> are the same. </para> <para> Optionally, the requester can supply the <code>Replace</code> parameter for each individual value. Setting this value to <code>true</code> will cause the new attribute values to replace the existing attribute values. For example, if an item <code>I</code> has the attributes <code>{ 'a', '1' }, { 'b', '2'}</code> and <code>{ 'b', '3' }</code> and the requester does a BatchPutAttributes of <code>{'I', 'b', '4' }</code> with the Replace parameter set to true, the final attributes of the item will be <code>{ 'a', '1' }</code> and <code>{ 'b', '4' }</code>, replacing the previous values of the 'b' attribute with the new value. </para> <important> This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method. This operation does not support conditions using <code>Expected.X.Name</code>, <code>Expected.X.Value</code>, or <code>Expected.X.Exists</code>. </important> <para> You can execute multiple <code>BatchPutAttributes</code> operations and other operations in parallel. However, large numbers of concurrent <code>BatchPutAttributes</code> calls can result in Service Unavailable (503) responses. </para> <para> The following limitations are enforced for this operation: <ul> <li>256 attribute name-value pairs per item</li> <li>1 MB request size</li> <li>1 billion attributes per domain</li> <li>10 GB of total user data storage per domain</li> <li>25 item limit per <code>BatchPutAttributes</code> operation</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the BatchPutAttributes service method.</param> <returns>The response from the BatchPutAttributes service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.DuplicateItemNameException"> The item name was specified more than once. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.SimpleDB.Model.MissingParameterException"> The request must contain the specified missing parameter. </exception> <exception cref="T:Amazon.SimpleDB.Model.NoSuchDomainException"> The specified domain does not exist. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberDomainAttributesExceededException"> Too many attributes in this domain. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberDomainBytesExceededException"> Too many bytes in this domain. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberItemAttributesExceededException"> Too many attributes in this item. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberSubmittedAttributesExceededException"> Too many attributes exist in a single call. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberSubmittedItemsExceededException"> Too many items exist in a single call. </exception> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.BatchPutAttributesAsync(Amazon.SimpleDB.Model.BatchPutAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the BatchPutAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchPutAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.CreateDomain(Amazon.SimpleDB.Model.CreateDomainRequest)"> <summary> The <code>CreateDomain</code> operation creates a new domain. The domain name should be unique among the domains associated with the Access Key ID provided in the request. The <code>CreateDomain</code> operation may take 10 or more seconds to complete. <para> The client can create up to 100 domains per account. </para> <para> If the client requires additional domains, go to <a href="http://aws.amazon.com/contact-us/simpledb-limit-request/"> http://aws.amazon.com/contact-us/simpledb-limit-request/</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain service method.</param> <returns>The response from the CreateDomain service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.SimpleDB.Model.MissingParameterException"> The request must contain the specified missing parameter. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberDomainsExceededException"> Too many domains exist per this account. </exception> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.CreateDomainAsync(Amazon.SimpleDB.Model.CreateDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.DeleteAttributes(Amazon.SimpleDB.Model.DeleteAttributesRequest)"> <summary> Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is deleted. <para> <code>DeleteAttributes</code> is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response. </para> <para> Because Amazon SimpleDB makes multiple copies of item data and uses an eventual consistency update model, performing a <a>GetAttributes</a> or <a>Select</a> operation (read) immediately after a <code>DeleteAttributes</code> or <a>PutAttributes</a> operation (write) might not return updated item data. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAttributes service method.</param> <returns>The response from the DeleteAttributes service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.AttributeDoesNotExistException"> The specified attribute does not exist. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.SimpleDB.Model.MissingParameterException"> The request must contain the specified missing parameter. </exception> <exception cref="T:Amazon.SimpleDB.Model.NoSuchDomainException"> The specified domain does not exist. </exception> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.DeleteAttributesAsync(Amazon.SimpleDB.Model.DeleteAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.DeleteDomain(Amazon.SimpleDB.Model.DeleteDomainRequest)"> <summary> The <code>DeleteDomain</code> operation deletes a domain. Any items (and their attributes) in the domain are deleted as well. The <code>DeleteDomain</code> operation might take 10 or more seconds to complete. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain service method.</param> <returns>The response from the DeleteDomain service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.MissingParameterException"> The request must contain the specified missing parameter. </exception> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.DeleteDomainAsync(Amazon.SimpleDB.Model.DeleteDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.DomainMetadata(Amazon.SimpleDB.Model.DomainMetadataRequest)"> <summary> Returns information about the domain, including when the domain was created, the number of items and attributes in the domain, and the size of the attribute names and values. </summary> <param name="request">Container for the necessary parameters to execute the DomainMetadata service method.</param> <returns>The response from the DomainMetadata service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.MissingParameterException"> The request must contain the specified missing parameter. </exception> <exception cref="T:Amazon.SimpleDB.Model.NoSuchDomainException"> The specified domain does not exist. </exception> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.DomainMetadataAsync(Amazon.SimpleDB.Model.DomainMetadataRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DomainMetadata operation. </summary> <param name="request">Container for the necessary parameters to execute the DomainMetadata operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.GetAttributes(Amazon.SimpleDB.Model.GetAttributesRequest)"> <summary> Returns all of the attributes associated with the specified item. Optionally, the attributes returned can be limited to one or more attributes by specifying an attribute name parameter. <para> If the item does not exist on the replica that was accessed for this operation, an empty set is returned. The system does not return an error as it cannot guarantee the item does not exist on other replicas. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetAttributes service method.</param> <returns>The response from the GetAttributes service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.SimpleDB.Model.MissingParameterException"> The request must contain the specified missing parameter. </exception> <exception cref="T:Amazon.SimpleDB.Model.NoSuchDomainException"> The specified domain does not exist. </exception> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.GetAttributesAsync(Amazon.SimpleDB.Model.GetAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.ListDomains"> <summary> The <code>ListDomains</code> operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by <a href="#MaxNumberOfDomains">MaxNumberOfDomains</a>. A <a href="#NextToken">NextToken</a> is returned if there are more than <code>MaxNumberOfDomains</code> domains. Calling <code>ListDomains</code> successive times with the <code>NextToken</code> provided by the operation returns up to <code>MaxNumberOfDomains</code> more domain names with each successive operation call. </summary> <returns>The response from the ListDomains service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.InvalidNextTokenException"> The specified NextToken is not valid. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.ListDomains(Amazon.SimpleDB.Model.ListDomainsRequest)"> <summary> The <code>ListDomains</code> operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by <a href="#MaxNumberOfDomains">MaxNumberOfDomains</a>. A <a href="#NextToken">NextToken</a> is returned if there are more than <code>MaxNumberOfDomains</code> domains. Calling <code>ListDomains</code> successive times with the <code>NextToken</code> provided by the operation returns up to <code>MaxNumberOfDomains</code> more domain names with each successive operation call. </summary> <param name="request">Container for the necessary parameters to execute the ListDomains service method.</param> <returns>The response from the ListDomains service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.InvalidNextTokenException"> The specified NextToken is not valid. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.ListDomainsAsync(Amazon.SimpleDB.Model.ListDomainsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDomains operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDomains operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.PutAttributes(Amazon.SimpleDB.Model.PutAttributesRequest)"> <summary> The PutAttributes operation creates or replaces attributes in an item. The client may specify new attributes using a combination of the <code>Attribute.X.Name</code> and <code>Attribute.X.Value</code> parameters. The client specifies the first attribute by the parameters <code>Attribute.0.Name</code> and <code>Attribute.0.Value</code>, the second attribute by the parameters <code>Attribute.1.Name</code> and <code>Attribute.1.Value</code>, and so on. <para> Attributes are uniquely identified in an item by their name/value combination. For example, a single item can have the attributes <code>{ "first_name", "first_value" }</code> and <code>{ "first_name", second_value" }</code>. However, it cannot have two attribute instances where both the <code>Attribute.X.Name</code> and <code>Attribute.X.Value</code> are the same. </para> <para> Optionally, the requestor can supply the <code>Replace</code> parameter for each individual attribute. Setting this value to <code>true</code> causes the new attribute value to replace the existing attribute value(s). For example, if an item has the attributes <code>{ 'a', '1' }</code>, <code>{ 'b', '2'}</code> and <code>{ 'b', '3' }</code> and the requestor calls <code>PutAttributes</code> using the attributes <code>{ 'b', '4' }</code> with the <code>Replace</code> parameter set to true, the final attributes of the item are changed to <code>{ 'a', '1' }</code> and <code>{ 'b', '4' }</code>, which replaces the previous values of the 'b' attribute with the new value. </para> <para> You cannot specify an empty string as an attribute name. </para> <para> Because Amazon SimpleDB makes multiple copies of client data and uses an eventual consistency update model, an immediate <a>GetAttributes</a> or <a>Select</a> operation (read) immediately after a <a>PutAttributes</a> or <a>DeleteAttributes</a> operation (write) might not return the updated data. </para> <para> The following limitations are enforced for this operation: <ul> <li>256 total attribute name-value pairs per item</li> <li>One billion attributes per domain</li> <li>10 GB of total user data storage per domain</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the PutAttributes service method.</param> <returns>The response from the PutAttributes service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.AttributeDoesNotExistException"> The specified attribute does not exist. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.SimpleDB.Model.MissingParameterException"> The request must contain the specified missing parameter. </exception> <exception cref="T:Amazon.SimpleDB.Model.NoSuchDomainException"> The specified domain does not exist. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberDomainAttributesExceededException"> Too many attributes in this domain. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberDomainBytesExceededException"> Too many bytes in this domain. </exception> <exception cref="T:Amazon.SimpleDB.Model.NumberItemAttributesExceededException"> Too many attributes in this item. </exception> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.PutAttributesAsync(Amazon.SimpleDB.Model.PutAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the PutAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.Select(Amazon.SimpleDB.Model.SelectRequest)"> <summary> The <code>Select</code> operation returns a set of attributes for <code>ItemNames</code> that match the select expression. <code>Select</code> is similar to the standard SQL SELECT statement. <para> The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items returned per page to enforce this limit. For example, if the client asks to retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100 items and an appropriate <code>NextToken</code> so the client can access the next page of results. </para> <para> For information on how to construct select expressions, see Using Select to Create Amazon SimpleDB Queries in the Developer Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the Select service method.</param> <returns>The response from the Select service method, as returned by SimpleDB.</returns> <exception cref="T:Amazon.SimpleDB.Model.InvalidNextTokenException"> The specified NextToken is not valid. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidNumberPredicatesException"> Too many predicates exist in the query expression. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidNumberValueTestsException"> Too many predicates exist in the query expression. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidParameterValueException"> The value for a parameter is invalid. </exception> <exception cref="T:Amazon.SimpleDB.Model.InvalidQueryExpressionException"> The specified query expression syntax is not valid. </exception> <exception cref="T:Amazon.SimpleDB.Model.MissingParameterException"> The request must contain the specified missing parameter. </exception> <exception cref="T:Amazon.SimpleDB.Model.NoSuchDomainException"> The specified domain does not exist. </exception> <exception cref="T:Amazon.SimpleDB.Model.RequestTimeoutException"> A timeout occurred when attempting to query the specified domain with specified query expression. </exception> <exception cref="T:Amazon.SimpleDB.Model.TooManyRequestedAttributesException"> Too many attributes requested. </exception> </member> <member name="M:Amazon.SimpleDB.AmazonSimpleDBClient.SelectAsync(Amazon.SimpleDB.Model.SelectRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Select operation. </summary> <param name="request">Container for the necessary parameters to execute the Select operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient"> <summary> Implementation for accessing SimpleEmailService Amazon Simple Email Service <para> This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be used in conjunction with the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon SES Developer Guide</a>. </para> <note>For a list of Amazon SES endpoints to use in service requests, see <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/regions.html">Regions and Amazon SES</a> in the Amazon SES Developer Guide. </note> </summary> </member> <member name="T:Amazon.SimpleEmail.IAmazonSimpleEmailService"> <summary> Interface for accessing SimpleEmailService Amazon Simple Email Service <para> This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be used in conjunction with the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon SES Developer Guide</a>. </para> <note>For a list of Amazon SES endpoints to use in service requests, see <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/regions.html">Regions and Amazon SES</a> in the Amazon SES Developer Guide. </note> </summary> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.CloneReceiptRuleSet(Amazon.SimpleEmail.Model.CloneReceiptRuleSetRequest)"> <summary> Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set. <para> For information about setting up rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the CloneReceiptRuleSet service method.</param> <returns>The response from the CloneReceiptRuleSet service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.AlreadyExistsException"> Indicates that a resource could not be created due to a naming conflict. </exception> <exception cref="T:Amazon.SimpleEmail.Model.LimitExceededException"> Indicates that a resource could not be created due to service limits. For a list of Amazon SES limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.CloneReceiptRuleSetAsync(Amazon.SimpleEmail.Model.CloneReceiptRuleSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CloneReceiptRuleSet operation. </summary> <param name="request">Container for the necessary parameters to execute the CloneReceiptRuleSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.CreateReceiptFilter(Amazon.SimpleEmail.Model.CreateReceiptFilterRequest)"> <summary> Creates a new IP address filter. <para> For information about setting up IP address filters, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateReceiptFilter service method.</param> <returns>The response from the CreateReceiptFilter service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.AlreadyExistsException"> Indicates that a resource could not be created due to a naming conflict. </exception> <exception cref="T:Amazon.SimpleEmail.Model.LimitExceededException"> Indicates that a resource could not be created due to service limits. For a list of Amazon SES limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES Developer Guide</a>. </exception> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.CreateReceiptFilterAsync(Amazon.SimpleEmail.Model.CreateReceiptFilterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateReceiptFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateReceiptFilter operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.CreateReceiptRule(Amazon.SimpleEmail.Model.CreateReceiptRuleRequest)"> <summary> Creates a receipt rule. <para> For information about setting up receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateReceiptRule service method.</param> <returns>The response from the CreateReceiptRule service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.AlreadyExistsException"> Indicates that a resource could not be created due to a naming conflict. </exception> <exception cref="T:Amazon.SimpleEmail.Model.InvalidLambdaFunctionException"> Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.InvalidS3ConfigurationException"> Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.InvalidSnsTopicException"> Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.LimitExceededException"> Indicates that a resource could not be created due to service limits. For a list of Amazon SES limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.RuleDoesNotExistException"> Indicates that the provided receipt rule does not exist. </exception> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.CreateReceiptRuleAsync(Amazon.SimpleEmail.Model.CreateReceiptRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateReceiptRule operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateReceiptRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.CreateReceiptRuleSet(Amazon.SimpleEmail.Model.CreateReceiptRuleSetRequest)"> <summary> Creates an empty receipt rule set. <para> For information about setting up receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateReceiptRuleSet service method.</param> <returns>The response from the CreateReceiptRuleSet service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.AlreadyExistsException"> Indicates that a resource could not be created due to a naming conflict. </exception> <exception cref="T:Amazon.SimpleEmail.Model.LimitExceededException"> Indicates that a resource could not be created due to service limits. For a list of Amazon SES limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES Developer Guide</a>. </exception> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.CreateReceiptRuleSetAsync(Amazon.SimpleEmail.Model.CreateReceiptRuleSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateReceiptRuleSet operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateReceiptRuleSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DeleteIdentity(Amazon.SimpleEmail.Model.DeleteIdentityRequest)"> <summary> Deletes the specified identity (email address or domain) from the list of verified identities. <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentity service method.</param> <returns>The response from the DeleteIdentity service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DeleteIdentityAsync(Amazon.SimpleEmail.Model.DeleteIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DeleteIdentityPolicy(Amazon.SimpleEmail.Model.DeleteIdentityPolicyRequest)"> <summary> Deletes the specified sending authorization policy for the given identity (email address or domain). This API returns successfully even if a policy with the specified name does not exist. <note>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</note> <para> Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentityPolicy service method.</param> <returns>The response from the DeleteIdentityPolicy service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DeleteIdentityPolicyAsync(Amazon.SimpleEmail.Model.DeleteIdentityPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteIdentityPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentityPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DeleteReceiptFilter(Amazon.SimpleEmail.Model.DeleteReceiptFilterRequest)"> <summary> Deletes the specified IP address filter. <para> For information about managing IP address filters, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteReceiptFilter service method.</param> <returns>The response from the DeleteReceiptFilter service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DeleteReceiptFilterAsync(Amazon.SimpleEmail.Model.DeleteReceiptFilterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteReceiptFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteReceiptFilter operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DeleteReceiptRule(Amazon.SimpleEmail.Model.DeleteReceiptRuleRequest)"> <summary> Deletes the specified receipt rule. <para> For information about managing receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteReceiptRule service method.</param> <returns>The response from the DeleteReceiptRule service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DeleteReceiptRuleAsync(Amazon.SimpleEmail.Model.DeleteReceiptRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteReceiptRule operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteReceiptRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DeleteReceiptRuleSet(Amazon.SimpleEmail.Model.DeleteReceiptRuleSetRequest)"> <summary> Deletes the specified receipt rule set and all of the receipt rules it contains. <note>The currently active rule set cannot be deleted.</note> <para> For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteReceiptRuleSet service method.</param> <returns>The response from the DeleteReceiptRuleSet service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.CannotDeleteException"> Indicates that the delete operation could not be completed. </exception> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DeleteReceiptRuleSetAsync(Amazon.SimpleEmail.Model.DeleteReceiptRuleSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteReceiptRuleSet operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteReceiptRuleSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DeleteVerifiedEmailAddress(Amazon.SimpleEmail.Model.DeleteVerifiedEmailAddressRequest)"> <summary> Deletes the specified email address from the list of verified addresses. <important>The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The DeleteIdentity action is now preferred.</important> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVerifiedEmailAddress service method.</param> <returns>The response from the DeleteVerifiedEmailAddress service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DeleteVerifiedEmailAddressAsync(Amazon.SimpleEmail.Model.DeleteVerifiedEmailAddressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVerifiedEmailAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVerifiedEmailAddress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DescribeActiveReceiptRuleSet(Amazon.SimpleEmail.Model.DescribeActiveReceiptRuleSetRequest)"> <summary> Returns the metadata and receipt rules for the receipt rule set that is currently active. <para> For information about setting up receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeActiveReceiptRuleSet service method.</param> <returns>The response from the DescribeActiveReceiptRuleSet service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DescribeActiveReceiptRuleSetAsync(Amazon.SimpleEmail.Model.DescribeActiveReceiptRuleSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeActiveReceiptRuleSet operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeActiveReceiptRuleSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DescribeReceiptRule(Amazon.SimpleEmail.Model.DescribeReceiptRuleRequest)"> <summary> Returns the details of the specified receipt rule. <para> For information about setting up receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReceiptRule service method.</param> <returns>The response from the DescribeReceiptRule service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.RuleDoesNotExistException"> Indicates that the provided receipt rule does not exist. </exception> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DescribeReceiptRuleAsync(Amazon.SimpleEmail.Model.DescribeReceiptRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReceiptRule operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReceiptRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DescribeReceiptRuleSet(Amazon.SimpleEmail.Model.DescribeReceiptRuleSetRequest)"> <summary> Returns the details of the specified receipt rule set. <para> For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReceiptRuleSet service method.</param> <returns>The response from the DescribeReceiptRuleSet service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.DescribeReceiptRuleSetAsync(Amazon.SimpleEmail.Model.DescribeReceiptRuleSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReceiptRuleSet operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReceiptRuleSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.GetIdentityDkimAttributes(Amazon.SimpleEmail.Model.GetIdentityDkimAttributesRequest)"> <summary> Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published. <para> This action takes a list of identities as input and returns the following information for each: </para> <ul> <li>Whether Easy DKIM signing is enabled or disabled.</li> <li>A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.</li> <li>Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.</li> </ul> <para> This action is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time. </para> <para> For more information about creating DNS records using DKIM tokens, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html">Amazon SES Developer Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityDkimAttributes service method.</param> <returns>The response from the GetIdentityDkimAttributes service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.GetIdentityDkimAttributesAsync(Amazon.SimpleEmail.Model.GetIdentityDkimAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetIdentityDkimAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityDkimAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.GetIdentityNotificationAttributes(Amazon.SimpleEmail.Model.GetIdentityNotificationAttributesRequest)"> <summary> Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes. <para> This action is throttled at one request per second and can only get notification attributes for up to 100 identities at a time. </para> <para> For more information about using notifications with Amazon SES, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityNotificationAttributes service method.</param> <returns>The response from the GetIdentityNotificationAttributes service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.GetIdentityNotificationAttributesAsync(Amazon.SimpleEmail.Model.GetIdentityNotificationAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetIdentityNotificationAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityNotificationAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.GetIdentityPolicies(Amazon.SimpleEmail.Model.GetIdentityPoliciesRequest)"> <summary> Returns the requested sending authorization policies for the given identity (email address or domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time. <note>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</note> <para> Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPolicies service method.</param> <returns>The response from the GetIdentityPolicies service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.GetIdentityPoliciesAsync(Amazon.SimpleEmail.Model.GetIdentityPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetIdentityPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.GetIdentityVerificationAttributes(Amazon.SimpleEmail.Model.GetIdentityVerificationAttributesRequest)"> <summary> Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity. <para> This action is throttled at one request per second and can only get verification attributes for up to 100 identities at a time. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityVerificationAttributes service method.</param> <returns>The response from the GetIdentityVerificationAttributes service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.GetIdentityVerificationAttributesAsync(Amazon.SimpleEmail.Model.GetIdentityVerificationAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetIdentityVerificationAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityVerificationAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.GetSendQuota"> <summary> Returns the user's current sending limits. <para> This action is throttled at one request per second. </para> </summary> <returns>The response from the GetSendQuota service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.GetSendQuota(Amazon.SimpleEmail.Model.GetSendQuotaRequest)"> <summary> Returns the user's current sending limits. <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetSendQuota service method.</param> <returns>The response from the GetSendQuota service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.GetSendQuotaAsync(Amazon.SimpleEmail.Model.GetSendQuotaRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSendQuota operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSendQuota operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.GetSendStatistics"> <summary> Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of sending activity. <para> Each data point in the list contains statistics for a 15-minute interval. </para> <para> This action is throttled at one request per second. </para> </summary> <returns>The response from the GetSendStatistics service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.GetSendStatistics(Amazon.SimpleEmail.Model.GetSendStatisticsRequest)"> <summary> Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of sending activity. <para> Each data point in the list contains statistics for a 15-minute interval. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetSendStatistics service method.</param> <returns>The response from the GetSendStatistics service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.GetSendStatisticsAsync(Amazon.SimpleEmail.Model.GetSendStatisticsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSendStatistics operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSendStatistics operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.ListIdentities"> <summary> Returns a list containing all of the identities (email addresses and domains) for a specific AWS Account, regardless of verification status. <para> This action is throttled at one request per second. </para> </summary> <returns>The response from the ListIdentities service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.ListIdentities(Amazon.SimpleEmail.Model.ListIdentitiesRequest)"> <summary> Returns a list containing all of the identities (email addresses and domains) for a specific AWS Account, regardless of verification status. <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListIdentities service method.</param> <returns>The response from the ListIdentities service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.ListIdentitiesAsync(Amazon.SimpleEmail.Model.ListIdentitiesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListIdentities operation. </summary> <param name="request">Container for the necessary parameters to execute the ListIdentities operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.ListIdentityPolicies(Amazon.SimpleEmail.Model.ListIdentityPoliciesRequest)"> <summary> Returns a list of sending authorization policies that are attached to the given identity (email address or domain). This API returns only a list. If you want the actual policy content, you can use <code>GetIdentityPolicies</code>. <note>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</note> <para> Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPolicies service method.</param> <returns>The response from the ListIdentityPolicies service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.ListIdentityPoliciesAsync(Amazon.SimpleEmail.Model.ListIdentityPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListIdentityPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.ListReceiptFilters(Amazon.SimpleEmail.Model.ListReceiptFiltersRequest)"> <summary> Lists the IP address filters associated with your account. <para> For information about managing IP address filters, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListReceiptFilters service method.</param> <returns>The response from the ListReceiptFilters service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.ListReceiptFiltersAsync(Amazon.SimpleEmail.Model.ListReceiptFiltersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListReceiptFilters operation. </summary> <param name="request">Container for the necessary parameters to execute the ListReceiptFilters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.ListReceiptRuleSets(Amazon.SimpleEmail.Model.ListReceiptRuleSetsRequest)"> <summary> Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be retrieved, you will receive a <code>NextToken</code> that you can provide to the next call to <code>ListReceiptRuleSets</code> to retrieve the additional entries. <para> For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListReceiptRuleSets service method.</param> <returns>The response from the ListReceiptRuleSets service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.ListReceiptRuleSetsAsync(Amazon.SimpleEmail.Model.ListReceiptRuleSetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListReceiptRuleSets operation. </summary> <param name="request">Container for the necessary parameters to execute the ListReceiptRuleSets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.ListVerifiedEmailAddresses"> <summary> Returns a list containing all of the email addresses that have been verified. <important>The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of Domain Verification. The ListIdentities action is now preferred.</important> <para> This action is throttled at one request per second. </para> </summary> <returns>The response from the ListVerifiedEmailAddresses service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.ListVerifiedEmailAddresses(Amazon.SimpleEmail.Model.ListVerifiedEmailAddressesRequest)"> <summary> Returns a list containing all of the email addresses that have been verified. <important>The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of Domain Verification. The ListIdentities action is now preferred.</important> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListVerifiedEmailAddresses service method.</param> <returns>The response from the ListVerifiedEmailAddresses service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.ListVerifiedEmailAddressesAsync(Amazon.SimpleEmail.Model.ListVerifiedEmailAddressesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListVerifiedEmailAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the ListVerifiedEmailAddresses operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.PutIdentityPolicy(Amazon.SimpleEmail.Model.PutIdentityPolicyRequest)"> <summary> Adds or updates a sending authorization policy for the specified identity (email address or domain). <note>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</note> <para> Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutIdentityPolicy service method.</param> <returns>The response from the PutIdentityPolicy service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.InvalidPolicyException"> Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error. </exception> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.PutIdentityPolicyAsync(Amazon.SimpleEmail.Model.PutIdentityPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutIdentityPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutIdentityPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.ReorderReceiptRuleSet(Amazon.SimpleEmail.Model.ReorderReceiptRuleSetRequest)"> <summary> Reorders the receipt rules within a receipt rule set. <note>All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules.</note> <para> For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReorderReceiptRuleSet service method.</param> <returns>The response from the ReorderReceiptRuleSet service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.RuleDoesNotExistException"> Indicates that the provided receipt rule does not exist. </exception> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.ReorderReceiptRuleSetAsync(Amazon.SimpleEmail.Model.ReorderReceiptRuleSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReorderReceiptRuleSet operation. </summary> <param name="request">Container for the necessary parameters to execute the ReorderReceiptRuleSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.SendBounce(Amazon.SimpleEmail.Model.SendBounceRequest)"> <summary> Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it. <note>You cannot use this API to send generic bounces for mail that was not received by Amazon SES.</note> <para> For information about receiving email through Amazon SES, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the SendBounce service method.</param> <returns>The response from the SendBounce service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.MessageRejectedException"> Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error. </exception> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.SendBounceAsync(Amazon.SimpleEmail.Model.SendBounceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SendBounce operation. </summary> <param name="request">Container for the necessary parameters to execute the SendBounce operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.SendEmail(Amazon.SimpleEmail.Model.SendEmailRequest)"> <summary> Composes an email message based on input data, and then immediately queues the message for sending. <para> There are several important points to know about <code>SendEmail</code>: </para> <ul> <li>You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES Developer Guide</a>.</li> <li>The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.</li> <li>Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.</li> <li>For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html">Amazon SES Developer Guide</a>.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the SendEmail service method.</param> <returns>The response from the SendEmail service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.MessageRejectedException"> Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error. </exception> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.SendEmailAsync(Amazon.SimpleEmail.Model.SendEmailRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SendEmail operation. </summary> <param name="request">Container for the necessary parameters to execute the SendEmail operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.SendRawEmail(Amazon.SimpleEmail.Model.SendRawEmailRequest)"> <summary> Sends an email message, with header and content specified by the client. The <code>SendRawEmail</code> action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet email standards; otherwise, the message cannot be sent. <para> There are several important points to know about <code>SendRawEmail</code>: </para> <ul> <li>You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES Developer Guide</a>.</li> <li>The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.</li> <li>Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.</li> <li>The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit.</li> <li>For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html">Amazon SES Developer Guide</a>.</li> <li>If you are using sending authorization to send on behalf of another user, <code>SendRawEmail</code> enables you to specify the cross-account identity for the email's "Source," "From," and "Return-Path" parameters in one of two ways: you can pass optional parameters <code>SourceArn</code>, <code>FromArn</code>, and/or <code>ReturnPathArn</code> to the API, or you can include the following X-headers in the header of your raw email: <ul> <li><code>X-SES-SOURCE-ARN</code></li> <li><code>X-SES-FROM-ARN</code></li> <li><code>X-SES-RETURN-PATH-ARN</code></li> </ul> <important>Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.</important> For the most common sending authorization use case, we recommend that you specify the <code>SourceIdentityArn</code> and do not specify either the <code>FromIdentityArn</code> or <code>ReturnPathIdentityArn</code>. (The same note applies to the corresponding X-headers.) If you only specify the <code>SourceIdentityArn</code>, Amazon SES will simply set the "From" address and the "Return Path" address to the identity specified in <code>SourceIdentityArn</code>. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the SendRawEmail service method.</param> <returns>The response from the SendRawEmail service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.MessageRejectedException"> Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error. </exception> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.SendRawEmailAsync(Amazon.SimpleEmail.Model.SendRawEmailRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SendRawEmail operation. </summary> <param name="request">Container for the necessary parameters to execute the SendRawEmail operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.SetActiveReceiptRuleSet(Amazon.SimpleEmail.Model.SetActiveReceiptRuleSetRequest)"> <summary> Sets the specified receipt rule set as the active receipt rule set. <note>To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.</note> <para> For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetActiveReceiptRuleSet service method.</param> <returns>The response from the SetActiveReceiptRuleSet service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.SetActiveReceiptRuleSetAsync(Amazon.SimpleEmail.Model.SetActiveReceiptRuleSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetActiveReceiptRuleSet operation. </summary> <param name="request">Container for the necessary parameters to execute the SetActiveReceiptRuleSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.SetIdentityDkimEnabled(Amazon.SimpleEmail.Model.SetIdentityDkimEnabledRequest)"> <summary> Enables or disables Easy DKIM signing of email sent from an identity: <ul> <li>If Easy DKIM signing is enabled for a domain name identity (e.g., <code>example.com</code>), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g., <code>user@example.com</code>).</li> <li>If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.</li> </ul> <para> For email addresses (e.g., <code>user@example.com</code>), you can only enable Easy DKIM signing if the corresponding domain (e.g., <code>example.com</code>) has been set up for Easy DKIM using the AWS Console or the <code>VerifyDomainDkim</code> action. </para> <para> This action is throttled at one request per second. </para> <para> For more information about Easy DKIM signing, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Amazon SES Developer Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityDkimEnabled service method.</param> <returns>The response from the SetIdentityDkimEnabled service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.SetIdentityDkimEnabledAsync(Amazon.SimpleEmail.Model.SetIdentityDkimEnabledRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetIdentityDkimEnabled operation. </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityDkimEnabled operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.SetIdentityFeedbackForwardingEnabled(Amazon.SimpleEmail.Model.SetIdentityFeedbackForwardingEnabledRequest)"> <summary> Given an identity (email address or domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints. <note>Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.</note> <para> This action is throttled at one request per second. </para> <para> For more information about using notifications with Amazon SES, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityFeedbackForwardingEnabled service method.</param> <returns>The response from the SetIdentityFeedbackForwardingEnabled service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.SetIdentityFeedbackForwardingEnabledAsync(Amazon.SimpleEmail.Model.SetIdentityFeedbackForwardingEnabledRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetIdentityFeedbackForwardingEnabled operation. </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityFeedbackForwardingEnabled operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.SetIdentityNotificationTopic(Amazon.SimpleEmail.Model.SetIdentityNotificationTopicRequest)"> <summary> Given an identity (email address or domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that identity as the <code>Source</code>. <note>Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications. For more information, see <code>SetIdentityFeedbackForwardingEnabled</code>. </note> <para> This action is throttled at one request per second. </para> <para> For more information about feedback notification, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityNotificationTopic service method.</param> <returns>The response from the SetIdentityNotificationTopic service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.SetIdentityNotificationTopicAsync(Amazon.SimpleEmail.Model.SetIdentityNotificationTopicRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetIdentityNotificationTopic operation. </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityNotificationTopic operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.SetReceiptRulePosition(Amazon.SimpleEmail.Model.SetReceiptRulePositionRequest)"> <summary> Sets the position of the specified receipt rule in the receipt rule set. <para> For information about managing receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetReceiptRulePosition service method.</param> <returns>The response from the SetReceiptRulePosition service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.RuleDoesNotExistException"> Indicates that the provided receipt rule does not exist. </exception> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.SetReceiptRulePositionAsync(Amazon.SimpleEmail.Model.SetReceiptRulePositionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetReceiptRulePosition operation. </summary> <param name="request">Container for the necessary parameters to execute the SetReceiptRulePosition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.UpdateReceiptRule(Amazon.SimpleEmail.Model.UpdateReceiptRuleRequest)"> <summary> Updates a receipt rule. <para> For information about managing receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateReceiptRule service method.</param> <returns>The response from the UpdateReceiptRule service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.InvalidLambdaFunctionException"> Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.InvalidS3ConfigurationException"> Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.InvalidSnsTopicException"> Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.LimitExceededException"> Indicates that a resource could not be created due to service limits. For a list of Amazon SES limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.RuleDoesNotExistException"> Indicates that the provided receipt rule does not exist. </exception> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.UpdateReceiptRuleAsync(Amazon.SimpleEmail.Model.UpdateReceiptRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateReceiptRule operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateReceiptRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.VerifyDomainDkim(Amazon.SimpleEmail.Model.VerifyDomainDkimRequest)"> <summary> Returns a set of DKIM tokens for a domain. DKIM <i>tokens</i> are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. <para> This action is throttled at one request per second. </para> <para> To enable or disable Easy DKIM signing for a domain, use the <code>SetIdentityDkimEnabled</code> action. </para> <para> For more information about creating DNS records using DKIM tokens, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html">Amazon SES Developer Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the VerifyDomainDkim service method.</param> <returns>The response from the VerifyDomainDkim service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.VerifyDomainDkimAsync(Amazon.SimpleEmail.Model.VerifyDomainDkimRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the VerifyDomainDkim operation. </summary> <param name="request">Container for the necessary parameters to execute the VerifyDomainDkim operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.VerifyDomainIdentity(Amazon.SimpleEmail.Model.VerifyDomainIdentityRequest)"> <summary> Verifies a domain. <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the VerifyDomainIdentity service method.</param> <returns>The response from the VerifyDomainIdentity service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.VerifyDomainIdentityAsync(Amazon.SimpleEmail.Model.VerifyDomainIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the VerifyDomainIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the VerifyDomainIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.VerifyEmailAddress(Amazon.SimpleEmail.Model.VerifyEmailAddressRequest)"> <summary> Verifies an email address. This action causes a confirmation email message to be sent to the specified address. <important>The VerifyEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The VerifyEmailIdentity action is now preferred.</important> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the VerifyEmailAddress service method.</param> <returns>The response from the VerifyEmailAddress service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.VerifyEmailAddressAsync(Amazon.SimpleEmail.Model.VerifyEmailAddressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the VerifyEmailAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the VerifyEmailAddress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.VerifyEmailIdentity(Amazon.SimpleEmail.Model.VerifyEmailIdentityRequest)"> <summary> Verifies an email address. This action causes a confirmation email message to be sent to the specified address. <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the VerifyEmailIdentity service method.</param> <returns>The response from the VerifyEmailIdentity service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.IAmazonSimpleEmailService.VerifyEmailIdentityAsync(Amazon.SimpleEmail.Model.VerifyEmailIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the VerifyEmailIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the VerifyEmailIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.#ctor"> <summary> Constructs AmazonSimpleEmailServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleEmailServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.#ctor(Amazon.SimpleEmail.AmazonSimpleEmailServiceConfig)"> <summary> Constructs AmazonSimpleEmailServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonSimpleEmailServiceClient Configuration Object</param> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonSimpleEmailServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleEmailServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.SimpleEmail.AmazonSimpleEmailServiceConfig)"> <summary> Constructs AmazonSimpleEmailServiceClient with AWS Credentials and an AmazonSimpleEmailServiceClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonSimpleEmailServiceClient Configuration Object</param> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.#ctor(System.String,System.String,Amazon.SimpleEmail.AmazonSimpleEmailServiceConfig)"> <summary> Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleEmailServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonSimpleEmailServiceClient Configuration Object</param> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.#ctor(System.String,System.String,System.String,Amazon.SimpleEmail.AmazonSimpleEmailServiceConfig)"> <summary> Constructs AmazonSimpleEmailServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleEmailServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonSimpleEmailServiceClient Configuration Object</param> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.CloneReceiptRuleSet(Amazon.SimpleEmail.Model.CloneReceiptRuleSetRequest)"> <summary> Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set. <para> For information about setting up rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the CloneReceiptRuleSet service method.</param> <returns>The response from the CloneReceiptRuleSet service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.AlreadyExistsException"> Indicates that a resource could not be created due to a naming conflict. </exception> <exception cref="T:Amazon.SimpleEmail.Model.LimitExceededException"> Indicates that a resource could not be created due to service limits. For a list of Amazon SES limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.CloneReceiptRuleSetAsync(Amazon.SimpleEmail.Model.CloneReceiptRuleSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CloneReceiptRuleSet operation. </summary> <param name="request">Container for the necessary parameters to execute the CloneReceiptRuleSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.CreateReceiptFilter(Amazon.SimpleEmail.Model.CreateReceiptFilterRequest)"> <summary> Creates a new IP address filter. <para> For information about setting up IP address filters, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateReceiptFilter service method.</param> <returns>The response from the CreateReceiptFilter service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.AlreadyExistsException"> Indicates that a resource could not be created due to a naming conflict. </exception> <exception cref="T:Amazon.SimpleEmail.Model.LimitExceededException"> Indicates that a resource could not be created due to service limits. For a list of Amazon SES limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES Developer Guide</a>. </exception> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.CreateReceiptFilterAsync(Amazon.SimpleEmail.Model.CreateReceiptFilterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateReceiptFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateReceiptFilter operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.CreateReceiptRule(Amazon.SimpleEmail.Model.CreateReceiptRuleRequest)"> <summary> Creates a receipt rule. <para> For information about setting up receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateReceiptRule service method.</param> <returns>The response from the CreateReceiptRule service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.AlreadyExistsException"> Indicates that a resource could not be created due to a naming conflict. </exception> <exception cref="T:Amazon.SimpleEmail.Model.InvalidLambdaFunctionException"> Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.InvalidS3ConfigurationException"> Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.InvalidSnsTopicException"> Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.LimitExceededException"> Indicates that a resource could not be created due to service limits. For a list of Amazon SES limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.RuleDoesNotExistException"> Indicates that the provided receipt rule does not exist. </exception> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.CreateReceiptRuleAsync(Amazon.SimpleEmail.Model.CreateReceiptRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateReceiptRule operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateReceiptRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.CreateReceiptRuleSet(Amazon.SimpleEmail.Model.CreateReceiptRuleSetRequest)"> <summary> Creates an empty receipt rule set. <para> For information about setting up receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateReceiptRuleSet service method.</param> <returns>The response from the CreateReceiptRuleSet service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.AlreadyExistsException"> Indicates that a resource could not be created due to a naming conflict. </exception> <exception cref="T:Amazon.SimpleEmail.Model.LimitExceededException"> Indicates that a resource could not be created due to service limits. For a list of Amazon SES limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES Developer Guide</a>. </exception> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.CreateReceiptRuleSetAsync(Amazon.SimpleEmail.Model.CreateReceiptRuleSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateReceiptRuleSet operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateReceiptRuleSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DeleteIdentity(Amazon.SimpleEmail.Model.DeleteIdentityRequest)"> <summary> Deletes the specified identity (email address or domain) from the list of verified identities. <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentity service method.</param> <returns>The response from the DeleteIdentity service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DeleteIdentityAsync(Amazon.SimpleEmail.Model.DeleteIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DeleteIdentityPolicy(Amazon.SimpleEmail.Model.DeleteIdentityPolicyRequest)"> <summary> Deletes the specified sending authorization policy for the given identity (email address or domain). This API returns successfully even if a policy with the specified name does not exist. <note>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</note> <para> Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentityPolicy service method.</param> <returns>The response from the DeleteIdentityPolicy service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DeleteIdentityPolicyAsync(Amazon.SimpleEmail.Model.DeleteIdentityPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteIdentityPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentityPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DeleteReceiptFilter(Amazon.SimpleEmail.Model.DeleteReceiptFilterRequest)"> <summary> Deletes the specified IP address filter. <para> For information about managing IP address filters, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteReceiptFilter service method.</param> <returns>The response from the DeleteReceiptFilter service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DeleteReceiptFilterAsync(Amazon.SimpleEmail.Model.DeleteReceiptFilterRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteReceiptFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteReceiptFilter operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DeleteReceiptRule(Amazon.SimpleEmail.Model.DeleteReceiptRuleRequest)"> <summary> Deletes the specified receipt rule. <para> For information about managing receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteReceiptRule service method.</param> <returns>The response from the DeleteReceiptRule service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DeleteReceiptRuleAsync(Amazon.SimpleEmail.Model.DeleteReceiptRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteReceiptRule operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteReceiptRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DeleteReceiptRuleSet(Amazon.SimpleEmail.Model.DeleteReceiptRuleSetRequest)"> <summary> Deletes the specified receipt rule set and all of the receipt rules it contains. <note>The currently active rule set cannot be deleted.</note> <para> For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteReceiptRuleSet service method.</param> <returns>The response from the DeleteReceiptRuleSet service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.CannotDeleteException"> Indicates that the delete operation could not be completed. </exception> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DeleteReceiptRuleSetAsync(Amazon.SimpleEmail.Model.DeleteReceiptRuleSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteReceiptRuleSet operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteReceiptRuleSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DeleteVerifiedEmailAddress(Amazon.SimpleEmail.Model.DeleteVerifiedEmailAddressRequest)"> <summary> Deletes the specified email address from the list of verified addresses. <important>The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The DeleteIdentity action is now preferred.</important> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVerifiedEmailAddress service method.</param> <returns>The response from the DeleteVerifiedEmailAddress service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DeleteVerifiedEmailAddressAsync(Amazon.SimpleEmail.Model.DeleteVerifiedEmailAddressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVerifiedEmailAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVerifiedEmailAddress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DescribeActiveReceiptRuleSet(Amazon.SimpleEmail.Model.DescribeActiveReceiptRuleSetRequest)"> <summary> Returns the metadata and receipt rules for the receipt rule set that is currently active. <para> For information about setting up receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeActiveReceiptRuleSet service method.</param> <returns>The response from the DescribeActiveReceiptRuleSet service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DescribeActiveReceiptRuleSetAsync(Amazon.SimpleEmail.Model.DescribeActiveReceiptRuleSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeActiveReceiptRuleSet operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeActiveReceiptRuleSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DescribeReceiptRule(Amazon.SimpleEmail.Model.DescribeReceiptRuleRequest)"> <summary> Returns the details of the specified receipt rule. <para> For information about setting up receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReceiptRule service method.</param> <returns>The response from the DescribeReceiptRule service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.RuleDoesNotExistException"> Indicates that the provided receipt rule does not exist. </exception> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DescribeReceiptRuleAsync(Amazon.SimpleEmail.Model.DescribeReceiptRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReceiptRule operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReceiptRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DescribeReceiptRuleSet(Amazon.SimpleEmail.Model.DescribeReceiptRuleSetRequest)"> <summary> Returns the details of the specified receipt rule set. <para> For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReceiptRuleSet service method.</param> <returns>The response from the DescribeReceiptRuleSet service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.DescribeReceiptRuleSetAsync(Amazon.SimpleEmail.Model.DescribeReceiptRuleSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeReceiptRuleSet operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReceiptRuleSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.GetIdentityDkimAttributes(Amazon.SimpleEmail.Model.GetIdentityDkimAttributesRequest)"> <summary> Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published. <para> This action takes a list of identities as input and returns the following information for each: </para> <ul> <li>Whether Easy DKIM signing is enabled or disabled.</li> <li>A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.</li> <li>Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.</li> </ul> <para> This action is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time. </para> <para> For more information about creating DNS records using DKIM tokens, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html">Amazon SES Developer Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityDkimAttributes service method.</param> <returns>The response from the GetIdentityDkimAttributes service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.GetIdentityDkimAttributesAsync(Amazon.SimpleEmail.Model.GetIdentityDkimAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetIdentityDkimAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityDkimAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.GetIdentityNotificationAttributes(Amazon.SimpleEmail.Model.GetIdentityNotificationAttributesRequest)"> <summary> Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes. <para> This action is throttled at one request per second and can only get notification attributes for up to 100 identities at a time. </para> <para> For more information about using notifications with Amazon SES, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityNotificationAttributes service method.</param> <returns>The response from the GetIdentityNotificationAttributes service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.GetIdentityNotificationAttributesAsync(Amazon.SimpleEmail.Model.GetIdentityNotificationAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetIdentityNotificationAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityNotificationAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.GetIdentityPolicies(Amazon.SimpleEmail.Model.GetIdentityPoliciesRequest)"> <summary> Returns the requested sending authorization policies for the given identity (email address or domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time. <note>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</note> <para> Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPolicies service method.</param> <returns>The response from the GetIdentityPolicies service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.GetIdentityPoliciesAsync(Amazon.SimpleEmail.Model.GetIdentityPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetIdentityPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.GetIdentityVerificationAttributes(Amazon.SimpleEmail.Model.GetIdentityVerificationAttributesRequest)"> <summary> Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity. <para> This action is throttled at one request per second and can only get verification attributes for up to 100 identities at a time. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityVerificationAttributes service method.</param> <returns>The response from the GetIdentityVerificationAttributes service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.GetIdentityVerificationAttributesAsync(Amazon.SimpleEmail.Model.GetIdentityVerificationAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetIdentityVerificationAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityVerificationAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.GetSendQuota"> <summary> Returns the user's current sending limits. <para> This action is throttled at one request per second. </para> </summary> <returns>The response from the GetSendQuota service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.GetSendQuota(Amazon.SimpleEmail.Model.GetSendQuotaRequest)"> <summary> Returns the user's current sending limits. <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetSendQuota service method.</param> <returns>The response from the GetSendQuota service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.GetSendQuotaAsync(Amazon.SimpleEmail.Model.GetSendQuotaRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSendQuota operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSendQuota operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.GetSendStatistics"> <summary> Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of sending activity. <para> Each data point in the list contains statistics for a 15-minute interval. </para> <para> This action is throttled at one request per second. </para> </summary> <returns>The response from the GetSendStatistics service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.GetSendStatistics(Amazon.SimpleEmail.Model.GetSendStatisticsRequest)"> <summary> Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of sending activity. <para> Each data point in the list contains statistics for a 15-minute interval. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetSendStatistics service method.</param> <returns>The response from the GetSendStatistics service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.GetSendStatisticsAsync(Amazon.SimpleEmail.Model.GetSendStatisticsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSendStatistics operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSendStatistics operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.ListIdentities"> <summary> Returns a list containing all of the identities (email addresses and domains) for a specific AWS Account, regardless of verification status. <para> This action is throttled at one request per second. </para> </summary> <returns>The response from the ListIdentities service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.ListIdentities(Amazon.SimpleEmail.Model.ListIdentitiesRequest)"> <summary> Returns a list containing all of the identities (email addresses and domains) for a specific AWS Account, regardless of verification status. <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListIdentities service method.</param> <returns>The response from the ListIdentities service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.ListIdentitiesAsync(Amazon.SimpleEmail.Model.ListIdentitiesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListIdentities operation. </summary> <param name="request">Container for the necessary parameters to execute the ListIdentities operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.ListIdentityPolicies(Amazon.SimpleEmail.Model.ListIdentityPoliciesRequest)"> <summary> Returns a list of sending authorization policies that are attached to the given identity (email address or domain). This API returns only a list. If you want the actual policy content, you can use <code>GetIdentityPolicies</code>. <note>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</note> <para> Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPolicies service method.</param> <returns>The response from the ListIdentityPolicies service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.ListIdentityPoliciesAsync(Amazon.SimpleEmail.Model.ListIdentityPoliciesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListIdentityPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPolicies operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.ListReceiptFilters(Amazon.SimpleEmail.Model.ListReceiptFiltersRequest)"> <summary> Lists the IP address filters associated with your account. <para> For information about managing IP address filters, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListReceiptFilters service method.</param> <returns>The response from the ListReceiptFilters service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.ListReceiptFiltersAsync(Amazon.SimpleEmail.Model.ListReceiptFiltersRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListReceiptFilters operation. </summary> <param name="request">Container for the necessary parameters to execute the ListReceiptFilters operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.ListReceiptRuleSets(Amazon.SimpleEmail.Model.ListReceiptRuleSetsRequest)"> <summary> Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be retrieved, you will receive a <code>NextToken</code> that you can provide to the next call to <code>ListReceiptRuleSets</code> to retrieve the additional entries. <para> For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListReceiptRuleSets service method.</param> <returns>The response from the ListReceiptRuleSets service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.ListReceiptRuleSetsAsync(Amazon.SimpleEmail.Model.ListReceiptRuleSetsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListReceiptRuleSets operation. </summary> <param name="request">Container for the necessary parameters to execute the ListReceiptRuleSets operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.ListVerifiedEmailAddresses"> <summary> Returns a list containing all of the email addresses that have been verified. <important>The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of Domain Verification. The ListIdentities action is now preferred.</important> <para> This action is throttled at one request per second. </para> </summary> <returns>The response from the ListVerifiedEmailAddresses service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.ListVerifiedEmailAddresses(Amazon.SimpleEmail.Model.ListVerifiedEmailAddressesRequest)"> <summary> Returns a list containing all of the email addresses that have been verified. <important>The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of Domain Verification. The ListIdentities action is now preferred.</important> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListVerifiedEmailAddresses service method.</param> <returns>The response from the ListVerifiedEmailAddresses service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.ListVerifiedEmailAddressesAsync(Amazon.SimpleEmail.Model.ListVerifiedEmailAddressesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListVerifiedEmailAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the ListVerifiedEmailAddresses operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.PutIdentityPolicy(Amazon.SimpleEmail.Model.PutIdentityPolicyRequest)"> <summary> Adds or updates a sending authorization policy for the specified identity (email address or domain). <note>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</note> <para> Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutIdentityPolicy service method.</param> <returns>The response from the PutIdentityPolicy service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.InvalidPolicyException"> Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error. </exception> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.PutIdentityPolicyAsync(Amazon.SimpleEmail.Model.PutIdentityPolicyRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PutIdentityPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutIdentityPolicy operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.ReorderReceiptRuleSet(Amazon.SimpleEmail.Model.ReorderReceiptRuleSetRequest)"> <summary> Reorders the receipt rules within a receipt rule set. <note>All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules.</note> <para> For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReorderReceiptRuleSet service method.</param> <returns>The response from the ReorderReceiptRuleSet service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.RuleDoesNotExistException"> Indicates that the provided receipt rule does not exist. </exception> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.ReorderReceiptRuleSetAsync(Amazon.SimpleEmail.Model.ReorderReceiptRuleSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReorderReceiptRuleSet operation. </summary> <param name="request">Container for the necessary parameters to execute the ReorderReceiptRuleSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.SendBounce(Amazon.SimpleEmail.Model.SendBounceRequest)"> <summary> Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it. <note>You cannot use this API to send generic bounces for mail that was not received by Amazon SES.</note> <para> For information about receiving email through Amazon SES, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the SendBounce service method.</param> <returns>The response from the SendBounce service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.MessageRejectedException"> Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error. </exception> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.SendBounceAsync(Amazon.SimpleEmail.Model.SendBounceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SendBounce operation. </summary> <param name="request">Container for the necessary parameters to execute the SendBounce operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.SendEmail(Amazon.SimpleEmail.Model.SendEmailRequest)"> <summary> Composes an email message based on input data, and then immediately queues the message for sending. <para> There are several important points to know about <code>SendEmail</code>: </para> <ul> <li>You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES Developer Guide</a>.</li> <li>The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.</li> <li>Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.</li> <li>For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html">Amazon SES Developer Guide</a>.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the SendEmail service method.</param> <returns>The response from the SendEmail service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.MessageRejectedException"> Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error. </exception> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.SendEmailAsync(Amazon.SimpleEmail.Model.SendEmailRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SendEmail operation. </summary> <param name="request">Container for the necessary parameters to execute the SendEmail operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.SendRawEmail(Amazon.SimpleEmail.Model.SendRawEmailRequest)"> <summary> Sends an email message, with header and content specified by the client. The <code>SendRawEmail</code> action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet email standards; otherwise, the message cannot be sent. <para> There are several important points to know about <code>SendRawEmail</code>: </para> <ul> <li>You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES Developer Guide</a>.</li> <li>The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.</li> <li>Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.</li> <li>The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit.</li> <li>For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html">Amazon SES Developer Guide</a>.</li> <li>If you are using sending authorization to send on behalf of another user, <code>SendRawEmail</code> enables you to specify the cross-account identity for the email's "Source," "From," and "Return-Path" parameters in one of two ways: you can pass optional parameters <code>SourceArn</code>, <code>FromArn</code>, and/or <code>ReturnPathArn</code> to the API, or you can include the following X-headers in the header of your raw email: <ul> <li><code>X-SES-SOURCE-ARN</code></li> <li><code>X-SES-FROM-ARN</code></li> <li><code>X-SES-RETURN-PATH-ARN</code></li> </ul> <important>Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.</important> For the most common sending authorization use case, we recommend that you specify the <code>SourceIdentityArn</code> and do not specify either the <code>FromIdentityArn</code> or <code>ReturnPathIdentityArn</code>. (The same note applies to the corresponding X-headers.) If you only specify the <code>SourceIdentityArn</code>, Amazon SES will simply set the "From" address and the "Return Path" address to the identity specified in <code>SourceIdentityArn</code>. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the SendRawEmail service method.</param> <returns>The response from the SendRawEmail service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.MessageRejectedException"> Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error. </exception> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.SendRawEmailAsync(Amazon.SimpleEmail.Model.SendRawEmailRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SendRawEmail operation. </summary> <param name="request">Container for the necessary parameters to execute the SendRawEmail operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.SetActiveReceiptRuleSet(Amazon.SimpleEmail.Model.SetActiveReceiptRuleSetRequest)"> <summary> Sets the specified receipt rule set as the active receipt rule set. <note>To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.</note> <para> For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetActiveReceiptRuleSet service method.</param> <returns>The response from the SetActiveReceiptRuleSet service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.SetActiveReceiptRuleSetAsync(Amazon.SimpleEmail.Model.SetActiveReceiptRuleSetRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetActiveReceiptRuleSet operation. </summary> <param name="request">Container for the necessary parameters to execute the SetActiveReceiptRuleSet operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.SetIdentityDkimEnabled(Amazon.SimpleEmail.Model.SetIdentityDkimEnabledRequest)"> <summary> Enables or disables Easy DKIM signing of email sent from an identity: <ul> <li>If Easy DKIM signing is enabled for a domain name identity (e.g., <code>example.com</code>), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g., <code>user@example.com</code>).</li> <li>If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.</li> </ul> <para> For email addresses (e.g., <code>user@example.com</code>), you can only enable Easy DKIM signing if the corresponding domain (e.g., <code>example.com</code>) has been set up for Easy DKIM using the AWS Console or the <code>VerifyDomainDkim</code> action. </para> <para> This action is throttled at one request per second. </para> <para> For more information about Easy DKIM signing, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Amazon SES Developer Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityDkimEnabled service method.</param> <returns>The response from the SetIdentityDkimEnabled service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.SetIdentityDkimEnabledAsync(Amazon.SimpleEmail.Model.SetIdentityDkimEnabledRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetIdentityDkimEnabled operation. </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityDkimEnabled operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.SetIdentityFeedbackForwardingEnabled(Amazon.SimpleEmail.Model.SetIdentityFeedbackForwardingEnabledRequest)"> <summary> Given an identity (email address or domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints. <note>Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.</note> <para> This action is throttled at one request per second. </para> <para> For more information about using notifications with Amazon SES, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityFeedbackForwardingEnabled service method.</param> <returns>The response from the SetIdentityFeedbackForwardingEnabled service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.SetIdentityFeedbackForwardingEnabledAsync(Amazon.SimpleEmail.Model.SetIdentityFeedbackForwardingEnabledRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetIdentityFeedbackForwardingEnabled operation. </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityFeedbackForwardingEnabled operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.SetIdentityNotificationTopic(Amazon.SimpleEmail.Model.SetIdentityNotificationTopicRequest)"> <summary> Given an identity (email address or domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that identity as the <code>Source</code>. <note>Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications. For more information, see <code>SetIdentityFeedbackForwardingEnabled</code>. </note> <para> This action is throttled at one request per second. </para> <para> For more information about feedback notification, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityNotificationTopic service method.</param> <returns>The response from the SetIdentityNotificationTopic service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.SetIdentityNotificationTopicAsync(Amazon.SimpleEmail.Model.SetIdentityNotificationTopicRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetIdentityNotificationTopic operation. </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityNotificationTopic operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.SetReceiptRulePosition(Amazon.SimpleEmail.Model.SetReceiptRulePositionRequest)"> <summary> Sets the position of the specified receipt rule in the receipt rule set. <para> For information about managing receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetReceiptRulePosition service method.</param> <returns>The response from the SetReceiptRulePosition service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.RuleDoesNotExistException"> Indicates that the provided receipt rule does not exist. </exception> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.SetReceiptRulePositionAsync(Amazon.SimpleEmail.Model.SetReceiptRulePositionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetReceiptRulePosition operation. </summary> <param name="request">Container for the necessary parameters to execute the SetReceiptRulePosition operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.UpdateReceiptRule(Amazon.SimpleEmail.Model.UpdateReceiptRuleRequest)"> <summary> Updates a receipt rule. <para> For information about managing receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html">Amazon SES Developer Guide</a>. </para> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateReceiptRule service method.</param> <returns>The response from the UpdateReceiptRule service method, as returned by SimpleEmailService.</returns> <exception cref="T:Amazon.SimpleEmail.Model.InvalidLambdaFunctionException"> Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.InvalidS3ConfigurationException"> Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.InvalidSnsTopicException"> Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.LimitExceededException"> Indicates that a resource could not be created due to service limits. For a list of Amazon SES limits, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html">Amazon SES Developer Guide</a>. </exception> <exception cref="T:Amazon.SimpleEmail.Model.RuleDoesNotExistException"> Indicates that the provided receipt rule does not exist. </exception> <exception cref="T:Amazon.SimpleEmail.Model.RuleSetDoesNotExistException"> Indicates that the provided receipt rule set does not exist. </exception> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.UpdateReceiptRuleAsync(Amazon.SimpleEmail.Model.UpdateReceiptRuleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateReceiptRule operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateReceiptRule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.VerifyDomainDkim(Amazon.SimpleEmail.Model.VerifyDomainDkimRequest)"> <summary> Returns a set of DKIM tokens for a domain. DKIM <i>tokens</i> are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. <para> This action is throttled at one request per second. </para> <para> To enable or disable Easy DKIM signing for a domain, use the <code>SetIdentityDkimEnabled</code> action. </para> <para> For more information about creating DNS records using DKIM tokens, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html">Amazon SES Developer Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the VerifyDomainDkim service method.</param> <returns>The response from the VerifyDomainDkim service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.VerifyDomainDkimAsync(Amazon.SimpleEmail.Model.VerifyDomainDkimRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the VerifyDomainDkim operation. </summary> <param name="request">Container for the necessary parameters to execute the VerifyDomainDkim operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.VerifyDomainIdentity(Amazon.SimpleEmail.Model.VerifyDomainIdentityRequest)"> <summary> Verifies a domain. <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the VerifyDomainIdentity service method.</param> <returns>The response from the VerifyDomainIdentity service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.VerifyDomainIdentityAsync(Amazon.SimpleEmail.Model.VerifyDomainIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the VerifyDomainIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the VerifyDomainIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.VerifyEmailAddress(Amazon.SimpleEmail.Model.VerifyEmailAddressRequest)"> <summary> Verifies an email address. This action causes a confirmation email message to be sent to the specified address. <important>The VerifyEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The VerifyEmailIdentity action is now preferred.</important> <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the VerifyEmailAddress service method.</param> <returns>The response from the VerifyEmailAddress service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.VerifyEmailAddressAsync(Amazon.SimpleEmail.Model.VerifyEmailAddressRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the VerifyEmailAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the VerifyEmailAddress operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.VerifyEmailIdentity(Amazon.SimpleEmail.Model.VerifyEmailIdentityRequest)"> <summary> Verifies an email address. This action causes a confirmation email message to be sent to the specified address. <para> This action is throttled at one request per second. </para> </summary> <param name="request">Container for the necessary parameters to execute the VerifyEmailIdentity service method.</param> <returns>The response from the VerifyEmailIdentity service method, as returned by SimpleEmailService.</returns> </member> <member name="M:Amazon.SimpleEmail.AmazonSimpleEmailServiceClient.VerifyEmailIdentityAsync(Amazon.SimpleEmail.Model.VerifyEmailIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the VerifyEmailIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the VerifyEmailIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient"> <summary> Implementation for accessing SimpleNotificationService Amazon Simple Notification Service <para> Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see <a href="http://aws.amazon.com/sns/">http://aws.amazon.com/sns</a>. For detailed information about Amazon SNS features and their associated API calls, see the <a href="http://docs.aws.amazon.com/sns/latest/dg/">Amazon SNS Developer Guide</a>. </para> <para> We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>. </para> </summary> </member> <member name="T:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService"> <summary> Interface for accessing SimpleNotificationService Amazon Simple Notification Service <para> Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see <a href="http://aws.amazon.com/sns/">http://aws.amazon.com/sns</a>. For detailed information about Amazon SNS features and their associated API calls, see the <a href="http://docs.aws.amazon.com/sns/latest/dg/">Amazon SNS Developer Guide</a>. </para> <para> We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>. </para> </summary> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.AddPermission(System.String,System.String,System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String})"> <summary> Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions. </summary> <param name="topicArn">The ARN of the topic whose access control policy you wish to modify.</param> <param name="label">A unique identifier for the new policy statement.</param> <param name="awsAccountId">The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service. </param> <param name="actionName">The action you want to allow for the specified principal(s). Valid values: any Amazon SNS action name.</param> <returns>The response from the AddPermission service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.AddPermission(Amazon.SimpleNotificationService.Model.AddPermissionRequest)"> <summary> Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions. </summary> <param name="request">Container for the necessary parameters to execute the AddPermission service method.</param> <returns>The response from the AddPermission service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.AddPermissionAsync(Amazon.SimpleNotificationService.Model.AddPermissionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddPermission operation. </summary> <param name="request">Container for the necessary parameters to execute the AddPermission operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ConfirmSubscription(System.String,System.String,System.String)"> <summary> Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier <code>Subscribe</code> action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the <code>AuthenticateOnUnsubscribe</code> flag is set to "true". </summary> <param name="topicArn">The ARN of the topic for which you wish to confirm a subscription.</param> <param name="token">Short-lived token sent to an endpoint during the <code>Subscribe</code> action.</param> <param name="authenticateOnUnsubscribe">Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is <code>true</code> and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication. </param> <returns>The response from the ConfirmSubscription service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.SubscriptionLimitExceededException"> Indicates that the customer already owns the maximum allowed number of subscriptions. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ConfirmSubscription(System.String,System.String)"> <summary> Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier <code>Subscribe</code> action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the <code>AuthenticateOnUnsubscribe</code> flag is set to "true". </summary> <param name="topicArn">The ARN of the topic for which you wish to confirm a subscription.</param> <param name="token">Short-lived token sent to an endpoint during the <code>Subscribe</code> action.</param> <returns>The response from the ConfirmSubscription service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.SubscriptionLimitExceededException"> Indicates that the customer already owns the maximum allowed number of subscriptions. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ConfirmSubscription(Amazon.SimpleNotificationService.Model.ConfirmSubscriptionRequest)"> <summary> Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier <code>Subscribe</code> action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the <code>AuthenticateOnUnsubscribe</code> flag is set to "true". </summary> <param name="request">Container for the necessary parameters to execute the ConfirmSubscription service method.</param> <returns>The response from the ConfirmSubscription service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.SubscriptionLimitExceededException"> Indicates that the customer already owns the maximum allowed number of subscriptions. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ConfirmSubscriptionAsync(Amazon.SimpleNotificationService.Model.ConfirmSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ConfirmSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.CreatePlatformApplication(Amazon.SimpleNotificationService.Model.CreatePlatformApplicationRequest)"> <summary> Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the <code>CreatePlatformApplication</code> action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". The PlatformApplicationArn that is returned when using <code>CreatePlatformApplication</code> is then used as an attribute for the <code>CreatePlatformEndpoint</code> action. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the CreatePlatformApplication service method.</param> <returns>The response from the CreatePlatformApplication service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.CreatePlatformApplicationAsync(Amazon.SimpleNotificationService.Model.CreatePlatformApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePlatformApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePlatformApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.CreatePlatformEndpoint(Amazon.SimpleNotificationService.Model.CreatePlatformEndpointRequest)"> <summary> Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. <code>CreatePlatformEndpoint</code> requires the PlatformApplicationArn that is returned from <code>CreatePlatformApplication</code>. The EndpointArn that is returned when using <code>CreatePlatformEndpoint</code> can then be used by the <code>Publish</code> action to send a message to a mobile app or by the <code>Subscribe</code> action for subscription to a topic. The <code>CreatePlatformEndpoint</code> action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. <para> When using <code>CreatePlatformEndpoint</code> with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html">Creating an Amazon SNS Endpoint for Baidu</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreatePlatformEndpoint service method.</param> <returns>The response from the CreatePlatformEndpoint service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.CreatePlatformEndpointAsync(Amazon.SimpleNotificationService.Model.CreatePlatformEndpointRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePlatformEndpoint operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePlatformEndpoint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.CreateTopic(System.String)"> <summary> Creates a topic to which notifications can be published. Users can create at most 3000 topics. For more information, see <a href="http://aws.amazon.com/sns/">http://aws.amazon.com/sns</a>. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic. </summary> <param name="name">The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. </param> <returns>The response from the CreateTopic service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.TopicLimitExceededException"> Indicates that the customer already owns the maximum allowed number of topics. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.CreateTopic(Amazon.SimpleNotificationService.Model.CreateTopicRequest)"> <summary> Creates a topic to which notifications can be published. Users can create at most 3000 topics. For more information, see <a href="http://aws.amazon.com/sns/">http://aws.amazon.com/sns</a>. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic. </summary> <param name="request">Container for the necessary parameters to execute the CreateTopic service method.</param> <returns>The response from the CreateTopic service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.TopicLimitExceededException"> Indicates that the customer already owns the maximum allowed number of topics. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.CreateTopicAsync(Amazon.SimpleNotificationService.Model.CreateTopicRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTopic operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTopic operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.DeleteEndpoint(Amazon.SimpleNotificationService.Model.DeleteEndpointRequest)"> <summary> Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEndpoint service method.</param> <returns>The response from the DeleteEndpoint service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.DeleteEndpointAsync(Amazon.SimpleNotificationService.Model.DeleteEndpointRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteEndpoint operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEndpoint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.DeletePlatformApplication(Amazon.SimpleNotificationService.Model.DeletePlatformApplicationRequest)"> <summary> Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the DeletePlatformApplication service method.</param> <returns>The response from the DeletePlatformApplication service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.DeletePlatformApplicationAsync(Amazon.SimpleNotificationService.Model.DeletePlatformApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePlatformApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePlatformApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.DeleteTopic(System.String)"> <summary> Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error. </summary> <param name="topicArn">The ARN of the topic you want to delete.<examples> <queryrequest> http://sns.us-east-1.amazonaws.com/ ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic &Action=DeleteTopic &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2010-03-31T12%3A00%3A00.000Z &AWSAccessKeyId=(AWS Access Key ID) &Signature=DjHBa%2BbYCKQAzctOPnLP7MbHnrHT3%2FK3kFEZjwcf9%2FU%3D </queryrequest> <queryresponse> <DeleteTopicResponse xmlns="http://sns.amazonaws.com/doc/2010-03-31/"> <ResponseMetadata> <RequestId>fba800b9-3765-11df-8cf3-c58c53254dfb</RequestId> </ResponseMetadata></DeleteTopicResponse> </queryresponse></examples></param> <returns>The response from the DeleteTopic service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.DeleteTopic(Amazon.SimpleNotificationService.Model.DeleteTopicRequest)"> <summary> Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTopic service method.</param> <returns>The response from the DeleteTopic service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.DeleteTopicAsync(Amazon.SimpleNotificationService.Model.DeleteTopicRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTopic operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTopic operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.GetEndpointAttributes(Amazon.SimpleNotificationService.Model.GetEndpointAttributesRequest)"> <summary> Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetEndpointAttributes service method.</param> <returns>The response from the GetEndpointAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.GetEndpointAttributesAsync(Amazon.SimpleNotificationService.Model.GetEndpointAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetEndpointAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetEndpointAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.GetPlatformApplicationAttributes(Amazon.SimpleNotificationService.Model.GetPlatformApplicationAttributesRequest)"> <summary> Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetPlatformApplicationAttributes service method.</param> <returns>The response from the GetPlatformApplicationAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.GetPlatformApplicationAttributesAsync(Amazon.SimpleNotificationService.Model.GetPlatformApplicationAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetPlatformApplicationAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPlatformApplicationAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.GetSubscriptionAttributes(System.String)"> <summary> Returns all of the properties of a subscription. </summary> <param name="subscriptionArn">The ARN of the subscription whose properties you want to get.</param> <returns>The response from the GetSubscriptionAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.GetSubscriptionAttributes(Amazon.SimpleNotificationService.Model.GetSubscriptionAttributesRequest)"> <summary> Returns all of the properties of a subscription. </summary> <param name="request">Container for the necessary parameters to execute the GetSubscriptionAttributes service method.</param> <returns>The response from the GetSubscriptionAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.GetSubscriptionAttributesAsync(Amazon.SimpleNotificationService.Model.GetSubscriptionAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSubscriptionAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSubscriptionAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.GetTopicAttributes(System.String)"> <summary> Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. </summary> <param name="topicArn">The ARN of the topic whose properties you want to get.</param> <returns>The response from the GetTopicAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.GetTopicAttributes(Amazon.SimpleNotificationService.Model.GetTopicAttributesRequest)"> <summary> Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. </summary> <param name="request">Container for the necessary parameters to execute the GetTopicAttributes service method.</param> <returns>The response from the GetTopicAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.GetTopicAttributesAsync(Amazon.SimpleNotificationService.Model.GetTopicAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetTopicAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTopicAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListEndpointsByPlatformApplication(Amazon.SimpleNotificationService.Model.ListEndpointsByPlatformApplicationRequest)"> <summary> Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for <code>ListEndpointsByPlatformApplication</code> are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListEndpointsByPlatformApplication</code> again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the ListEndpointsByPlatformApplication service method.</param> <returns>The response from the ListEndpointsByPlatformApplication service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListEndpointsByPlatformApplicationAsync(Amazon.SimpleNotificationService.Model.ListEndpointsByPlatformApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListEndpointsByPlatformApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the ListEndpointsByPlatformApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListPlatformApplications"> <summary> Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for <code>ListPlatformApplications</code> are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListPlatformApplications</code> using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <returns>The response from the ListPlatformApplications service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListPlatformApplications(Amazon.SimpleNotificationService.Model.ListPlatformApplicationsRequest)"> <summary> Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for <code>ListPlatformApplications</code> are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListPlatformApplications</code> using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the ListPlatformApplications service method.</param> <returns>The response from the ListPlatformApplications service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListPlatformApplicationsAsync(Amazon.SimpleNotificationService.Model.ListPlatformApplicationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListPlatformApplications operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPlatformApplications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListSubscriptions"> <summary> Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptions</code> call to get further results. </summary> <returns>The response from the ListSubscriptions service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListSubscriptions(System.String)"> <summary> Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptions</code> call to get further results. </summary> <param name="nextToken">Token returned by the previous <code>ListSubscriptions</code> request.</param> <returns>The response from the ListSubscriptions service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListSubscriptions(Amazon.SimpleNotificationService.Model.ListSubscriptionsRequest)"> <summary> Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptions</code> call to get further results. </summary> <param name="request">Container for the necessary parameters to execute the ListSubscriptions service method.</param> <returns>The response from the ListSubscriptions service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListSubscriptionsAsync(Amazon.SimpleNotificationService.Model.ListSubscriptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListSubscriptions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSubscriptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListSubscriptionsByTopic(System.String,System.String)"> <summary> Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptionsByTopic</code> call to get further results. </summary> <param name="topicArn">The ARN of the topic for which you wish to find subscriptions.</param> <param name="nextToken">Token returned by the previous <code>ListSubscriptionsByTopic</code> request.</param> <returns>The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListSubscriptionsByTopic(System.String)"> <summary> Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptionsByTopic</code> call to get further results. </summary> <param name="topicArn">The ARN of the topic for which you wish to find subscriptions.</param> <returns>The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListSubscriptionsByTopic(Amazon.SimpleNotificationService.Model.ListSubscriptionsByTopicRequest)"> <summary> Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptionsByTopic</code> call to get further results. </summary> <param name="request">Container for the necessary parameters to execute the ListSubscriptionsByTopic service method.</param> <returns>The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListSubscriptionsByTopicAsync(Amazon.SimpleNotificationService.Model.ListSubscriptionsByTopicRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListSubscriptionsByTopic operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSubscriptionsByTopic operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListTopics"> <summary> Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListTopics</code> call to get further results. </summary> <returns>The response from the ListTopics service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListTopics(System.String)"> <summary> Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListTopics</code> call to get further results. </summary> <param name="nextToken">Token returned by the previous <code>ListTopics</code> request.</param> <returns>The response from the ListTopics service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListTopics(Amazon.SimpleNotificationService.Model.ListTopicsRequest)"> <summary> Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListTopics</code> call to get further results. </summary> <param name="request">Container for the necessary parameters to execute the ListTopics service method.</param> <returns>The response from the ListTopics service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.ListTopicsAsync(Amazon.SimpleNotificationService.Model.ListTopicsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTopics operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTopics operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.Publish(System.String,System.String)"> <summary> Sends a message to all of a topic's subscribed endpoints. When a <code>messageId</code> is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected. <para> To use the <code>Publish</code> action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn. The EndpointArn is returned when making a call with the <code>CreatePlatformEndpoint</code> action. The second example below shows a request and response for publishing to a mobile endpoint. </para> </summary> <param name="topicArn">The topic you want to publish to.</param> <param name="message">The message you want to send to the topic. If you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the <code>MessageStructure</code> parameter to <code>json</code> and use a JSON object for the <code>Message</code> parameter. See the Examples section for the format of the JSON object. Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters). JSON-specific constraints: <ul> <li>Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values. </li> <li>The values will be parsed (unescaped) before they are used in outgoing messages.</li> <li>Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).</li> <li>Values have a minimum length of 0 (the empty string, "", is allowed).</li> <li>Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).</li> <li>Non-string values will cause the key to be ignored.</li> <li>Keys that do not correspond to supported transport protocols are ignored.</li> <li>Duplicate keys are not allowed.</li> <li>Failure to parse or validate any key or value in the message will cause the <code>Publish</code> call to return an error (no partial delivery).</li> </ul> </param> <returns>The response from the Publish service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.EndpointDisabledException"> Exception error indicating endpoint disabled. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterValueException"> </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.PlatformApplicationDisabledException"> Exception error indicating platform application disabled. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.Publish(System.String,System.String,System.String)"> <summary> Sends a message to all of a topic's subscribed endpoints. When a <code>messageId</code> is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected. <para> To use the <code>Publish</code> action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn. The EndpointArn is returned when making a call with the <code>CreatePlatformEndpoint</code> action. The second example below shows a request and response for publishing to a mobile endpoint. </para> </summary> <param name="topicArn">The topic you want to publish to.</param> <param name="message">The message you want to send to the topic. If you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the <code>MessageStructure</code> parameter to <code>json</code> and use a JSON object for the <code>Message</code> parameter. See the Examples section for the format of the JSON object. Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters). JSON-specific constraints: <ul> <li>Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values. </li> <li>The values will be parsed (unescaped) before they are used in outgoing messages.</li> <li>Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).</li> <li>Values have a minimum length of 0 (the empty string, "", is allowed).</li> <li>Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).</li> <li>Non-string values will cause the key to be ignored.</li> <li>Keys that do not correspond to supported transport protocols are ignored.</li> <li>Duplicate keys are not allowed.</li> <li>Failure to parse or validate any key or value in the message will cause the <code>Publish</code> call to return an error (no partial delivery).</li> </ul> </param> <param name="subject">Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.</param> <returns>The response from the Publish service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.EndpointDisabledException"> Exception error indicating endpoint disabled. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterValueException"> </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.PlatformApplicationDisabledException"> Exception error indicating platform application disabled. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.Publish(Amazon.SimpleNotificationService.Model.PublishRequest)"> <summary> Sends a message to all of a topic's subscribed endpoints. When a <code>messageId</code> is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected. <para> To use the <code>Publish</code> action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn. The EndpointArn is returned when making a call with the <code>CreatePlatformEndpoint</code> action. The second example below shows a request and response for publishing to a mobile endpoint. </para> </summary> <param name="request">Container for the necessary parameters to execute the Publish service method.</param> <returns>The response from the Publish service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.EndpointDisabledException"> Exception error indicating endpoint disabled. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterValueException"> </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.PlatformApplicationDisabledException"> Exception error indicating platform application disabled. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.PublishAsync(Amazon.SimpleNotificationService.Model.PublishRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Publish operation. </summary> <param name="request">Container for the necessary parameters to execute the Publish operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.RemovePermission(System.String,System.String)"> <summary> Removes a statement from a topic's access control policy. </summary> <param name="topicArn">The ARN of the topic whose access control policy you wish to modify.</param> <param name="label">The unique label of the statement you want to remove.</param> <returns>The response from the RemovePermission service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.RemovePermission(Amazon.SimpleNotificationService.Model.RemovePermissionRequest)"> <summary> Removes a statement from a topic's access control policy. </summary> <param name="request">Container for the necessary parameters to execute the RemovePermission service method.</param> <returns>The response from the RemovePermission service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.RemovePermissionAsync(Amazon.SimpleNotificationService.Model.RemovePermissionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemovePermission operation. </summary> <param name="request">Container for the necessary parameters to execute the RemovePermission operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.SetEndpointAttributes(Amazon.SimpleNotificationService.Model.SetEndpointAttributesRequest)"> <summary> Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the SetEndpointAttributes service method.</param> <returns>The response from the SetEndpointAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.SetEndpointAttributesAsync(Amazon.SimpleNotificationService.Model.SetEndpointAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetEndpointAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the SetEndpointAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.SetPlatformApplicationAttributes(Amazon.SimpleNotificationService.Model.SetPlatformApplicationAttributesRequest)"> <summary> Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the SetPlatformApplicationAttributes service method.</param> <returns>The response from the SetPlatformApplicationAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.SetPlatformApplicationAttributesAsync(Amazon.SimpleNotificationService.Model.SetPlatformApplicationAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetPlatformApplicationAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the SetPlatformApplicationAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.SetSubscriptionAttributes(System.String,System.String,System.String)"> <summary> Allows a subscription owner to set an attribute of the topic to a new value. </summary> <param name="subscriptionArn">The ARN of the subscription to modify.</param> <param name="attributeName">The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable. Valid values: <code>DeliveryPolicy</code> | <code>RawMessageDelivery</code></param> <param name="attributeValue">The new value for the attribute in JSON format.</param> <returns>The response from the SetSubscriptionAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.SetSubscriptionAttributes(Amazon.SimpleNotificationService.Model.SetSubscriptionAttributesRequest)"> <summary> Allows a subscription owner to set an attribute of the topic to a new value. </summary> <param name="request">Container for the necessary parameters to execute the SetSubscriptionAttributes service method.</param> <returns>The response from the SetSubscriptionAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.SetSubscriptionAttributesAsync(Amazon.SimpleNotificationService.Model.SetSubscriptionAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetSubscriptionAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the SetSubscriptionAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.SetTopicAttributes(System.String,System.String,System.String)"> <summary> Allows a topic owner to set an attribute of the topic to a new value. </summary> <param name="topicArn">The ARN of the topic to modify.</param> <param name="attributeName">The name of the attribute you want to set. Only a subset of the topic's attributes are mutable. Valid values: <code>Policy</code> | <code>DisplayName</code> | <code>DeliveryPolicy</code></param> <param name="attributeValue">The new value for the attribute.</param> <returns>The response from the SetTopicAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.SetTopicAttributes(Amazon.SimpleNotificationService.Model.SetTopicAttributesRequest)"> <summary> Allows a topic owner to set an attribute of the topic to a new value. </summary> <param name="request">Container for the necessary parameters to execute the SetTopicAttributes service method.</param> <returns>The response from the SetTopicAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.SetTopicAttributesAsync(Amazon.SimpleNotificationService.Model.SetTopicAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetTopicAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the SetTopicAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.Subscribe(System.String,System.String,System.String)"> <summary> Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the <code>ConfirmSubscription</code> action with the token from the confirmation message. Confirmation tokens are valid for three days. </summary> <param name="topicArn">The ARN of the topic you want to subscribe to.</param> <param name="protocol">The protocol you want to use. Supported protocols include: <ul> <li><code>http</code> -- delivery of JSON-encoded message via HTTP POST</li> <li><code>https</code> -- delivery of JSON-encoded message via HTTPS POST</li> <li><code>email</code> -- delivery of message via SMTP</li> <li><code>email-json</code> -- delivery of JSON-encoded message via SMTP</li> <li><code>sms</code> -- delivery of message via SMS</li> <li><code>sqs</code> -- delivery of JSON-encoded message to an Amazon SQS queue</li> <li><code>application</code> -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.</li> </ul></param> <param name="endpoint">The endpoint that you want to receive notifications. Endpoints vary by protocol: <ul> <li>For the <code>http</code> protocol, the endpoint is an URL beginning with "http://"</li> <li>For the <code>https</code> protocol, the endpoint is a URL beginning with "https://"</li> <li>For the <code>email</code> protocol, the endpoint is an email address</li> <li>For the <code>email-json</code> protocol, the endpoint is an email address</li> <li>For the <code>sms</code> protocol, the endpoint is a phone number of an SMS-enabled device</li> <li>For the <code>sqs</code> protocol, the endpoint is the ARN of an Amazon SQS queue</li> <li>For the <code>application</code> protocol, the endpoint is the EndpointArn of a mobile app and device.</li> </ul></param> <returns>The response from the Subscribe service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.SubscriptionLimitExceededException"> Indicates that the customer already owns the maximum allowed number of subscriptions. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.Subscribe(Amazon.SimpleNotificationService.Model.SubscribeRequest)"> <summary> Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the <code>ConfirmSubscription</code> action with the token from the confirmation message. Confirmation tokens are valid for three days. </summary> <param name="request">Container for the necessary parameters to execute the Subscribe service method.</param> <returns>The response from the Subscribe service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.SubscriptionLimitExceededException"> Indicates that the customer already owns the maximum allowed number of subscriptions. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.SubscribeAsync(Amazon.SimpleNotificationService.Model.SubscribeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Subscribe operation. </summary> <param name="request">Container for the necessary parameters to execute the Subscribe operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.Unsubscribe(System.String)"> <summary> Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the <code>Unsubscribe</code> call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the <code>Unsubscribe</code> request was unintended. </summary> <param name="subscriptionArn">The ARN of the subscription to be deleted.</param> <returns>The response from the Unsubscribe service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.Unsubscribe(Amazon.SimpleNotificationService.Model.UnsubscribeRequest)"> <summary> Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the <code>Unsubscribe</code> call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the <code>Unsubscribe</code> request was unintended. </summary> <param name="request">Container for the necessary parameters to execute the Unsubscribe service method.</param> <returns>The response from the Unsubscribe service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.UnsubscribeAsync(Amazon.SimpleNotificationService.Model.UnsubscribeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Unsubscribe operation. </summary> <param name="request">Container for the necessary parameters to execute the Unsubscribe operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.SubscribeQueue(System.String,Amazon.SQS.IAmazonSQS,System.String)"> <summary> Subscribes an existing Amazon SQS queue to an existing Amazon SNS topic. <para> The policy applied to the SQS queue is similar to this: <code> { "Version" : "2008-10-17", "Statement" : [{ "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic", "Effect" : "Allow", "Principal" : { "AWS":["*"] }, "Action" : ["sqs:SendMessage"], "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"], "Condition" : { "ArnLike":{ "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"] } } }] } </code> </para> <para> There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue. </para> </summary> <param name="topicArn">The topic to subscribe to</param> <param name="sqsClient">The SQS client used to get attributes and set the policy on the SQS queue.</param> <param name="sqsQueueUrl">The queue to add a subscription to.</param> <returns>The subscription ARN as returned by Amazon SNS when the queue is successfully subscribed to the topic.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.FindTopic(System.String)"> <summary> Finds an existing Amazon SNS topic by iterating all SNS topics until a match is found. <para> The ListTopics method is used to fetch upto 100 SNS topics at a time until a SNS topic with an TopicArn that matches <paramref name="topicName"/> is found. </para> </summary> <param name="topicName">The name of the topic find</param> <returns>The matched SNS topic.</returns> </member> <member name="M:Amazon.SimpleNotificationService.IAmazonSimpleNotificationService.AuthorizeS3ToPublish(System.String,System.String)"> <summary> This is a utility method which updates the policy of a topic to allow the S3 bucket to publish events to it. </summary> <param name="topicArn">The topic that will have its policy updated.</param> <param name="bucket">The bucket that will be given access to publish from.</param> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.#ctor"> <summary> Constructs AmazonSimpleNotificationServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleNotificationServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.#ctor(Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceConfig)"> <summary> Constructs AmazonSimpleNotificationServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonSimpleNotificationServiceClient Configuration Object</param> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonSimpleNotificationServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleNotificationServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceConfig)"> <summary> Constructs AmazonSimpleNotificationServiceClient with AWS Credentials and an AmazonSimpleNotificationServiceClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonSimpleNotificationServiceClient Configuration Object</param> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.#ctor(System.String,System.String,Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceConfig)"> <summary> Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleNotificationServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonSimpleNotificationServiceClient Configuration Object</param> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.#ctor(System.String,System.String,System.String,Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceConfig)"> <summary> Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleNotificationServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonSimpleNotificationServiceClient Configuration Object</param> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AddPermission(System.String,System.String,System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String})"> <summary> Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions. </summary> <param name="topicArn">The ARN of the topic whose access control policy you wish to modify.</param> <param name="label">A unique identifier for the new policy statement.</param> <param name="awsAccountId">The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service. </param> <param name="actionName">The action you want to allow for the specified principal(s). Valid values: any Amazon SNS action name.</param> <returns>The response from the AddPermission service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AddPermission(Amazon.SimpleNotificationService.Model.AddPermissionRequest)"> <summary> Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions. </summary> <param name="request">Container for the necessary parameters to execute the AddPermission service method.</param> <returns>The response from the AddPermission service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AddPermissionAsync(Amazon.SimpleNotificationService.Model.AddPermissionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddPermission operation. </summary> <param name="request">Container for the necessary parameters to execute the AddPermission operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ConfirmSubscription(System.String,System.String,System.String)"> <summary> Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier <code>Subscribe</code> action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the <code>AuthenticateOnUnsubscribe</code> flag is set to "true". </summary> <param name="topicArn">The ARN of the topic for which you wish to confirm a subscription.</param> <param name="token">Short-lived token sent to an endpoint during the <code>Subscribe</code> action.</param> <param name="authenticateOnUnsubscribe">Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is <code>true</code> and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication. </param> <returns>The response from the ConfirmSubscription service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.SubscriptionLimitExceededException"> Indicates that the customer already owns the maximum allowed number of subscriptions. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ConfirmSubscription(System.String,System.String)"> <summary> Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier <code>Subscribe</code> action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the <code>AuthenticateOnUnsubscribe</code> flag is set to "true". </summary> <param name="topicArn">The ARN of the topic for which you wish to confirm a subscription.</param> <param name="token">Short-lived token sent to an endpoint during the <code>Subscribe</code> action.</param> <returns>The response from the ConfirmSubscription service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.SubscriptionLimitExceededException"> Indicates that the customer already owns the maximum allowed number of subscriptions. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ConfirmSubscription(Amazon.SimpleNotificationService.Model.ConfirmSubscriptionRequest)"> <summary> Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier <code>Subscribe</code> action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the <code>AuthenticateOnUnsubscribe</code> flag is set to "true". </summary> <param name="request">Container for the necessary parameters to execute the ConfirmSubscription service method.</param> <returns>The response from the ConfirmSubscription service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.SubscriptionLimitExceededException"> Indicates that the customer already owns the maximum allowed number of subscriptions. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ConfirmSubscriptionAsync(Amazon.SimpleNotificationService.Model.ConfirmSubscriptionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ConfirmSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmSubscription operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.CreatePlatformApplication(Amazon.SimpleNotificationService.Model.CreatePlatformApplicationRequest)"> <summary> Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the <code>CreatePlatformApplication</code> action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". The PlatformApplicationArn that is returned when using <code>CreatePlatformApplication</code> is then used as an attribute for the <code>CreatePlatformEndpoint</code> action. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the CreatePlatformApplication service method.</param> <returns>The response from the CreatePlatformApplication service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.CreatePlatformApplicationAsync(Amazon.SimpleNotificationService.Model.CreatePlatformApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePlatformApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePlatformApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.CreatePlatformEndpoint(Amazon.SimpleNotificationService.Model.CreatePlatformEndpointRequest)"> <summary> Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. <code>CreatePlatformEndpoint</code> requires the PlatformApplicationArn that is returned from <code>CreatePlatformApplication</code>. The EndpointArn that is returned when using <code>CreatePlatformEndpoint</code> can then be used by the <code>Publish</code> action to send a message to a mobile app or by the <code>Subscribe</code> action for subscription to a topic. The <code>CreatePlatformEndpoint</code> action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. <para> When using <code>CreatePlatformEndpoint</code> with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html">Creating an Amazon SNS Endpoint for Baidu</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreatePlatformEndpoint service method.</param> <returns>The response from the CreatePlatformEndpoint service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.CreatePlatformEndpointAsync(Amazon.SimpleNotificationService.Model.CreatePlatformEndpointRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreatePlatformEndpoint operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePlatformEndpoint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.CreateTopic(System.String)"> <summary> Creates a topic to which notifications can be published. Users can create at most 3000 topics. For more information, see <a href="http://aws.amazon.com/sns/">http://aws.amazon.com/sns</a>. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic. </summary> <param name="name">The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. </param> <returns>The response from the CreateTopic service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.TopicLimitExceededException"> Indicates that the customer already owns the maximum allowed number of topics. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.CreateTopic(Amazon.SimpleNotificationService.Model.CreateTopicRequest)"> <summary> Creates a topic to which notifications can be published. Users can create at most 3000 topics. For more information, see <a href="http://aws.amazon.com/sns/">http://aws.amazon.com/sns</a>. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic. </summary> <param name="request">Container for the necessary parameters to execute the CreateTopic service method.</param> <returns>The response from the CreateTopic service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.TopicLimitExceededException"> Indicates that the customer already owns the maximum allowed number of topics. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.CreateTopicAsync(Amazon.SimpleNotificationService.Model.CreateTopicRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTopic operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTopic operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.DeleteEndpoint(Amazon.SimpleNotificationService.Model.DeleteEndpointRequest)"> <summary> Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEndpoint service method.</param> <returns>The response from the DeleteEndpoint service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.DeleteEndpointAsync(Amazon.SimpleNotificationService.Model.DeleteEndpointRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteEndpoint operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteEndpoint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.DeletePlatformApplication(Amazon.SimpleNotificationService.Model.DeletePlatformApplicationRequest)"> <summary> Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the DeletePlatformApplication service method.</param> <returns>The response from the DeletePlatformApplication service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.DeletePlatformApplicationAsync(Amazon.SimpleNotificationService.Model.DeletePlatformApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeletePlatformApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePlatformApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.DeleteTopic(System.String)"> <summary> Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error. </summary> <param name="topicArn">The ARN of the topic you want to delete.<examples> <queryrequest> http://sns.us-east-1.amazonaws.com/ ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic &Action=DeleteTopic &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2010-03-31T12%3A00%3A00.000Z &AWSAccessKeyId=(AWS Access Key ID) &Signature=DjHBa%2BbYCKQAzctOPnLP7MbHnrHT3%2FK3kFEZjwcf9%2FU%3D </queryrequest> <queryresponse> <DeleteTopicResponse xmlns="http://sns.amazonaws.com/doc/2010-03-31/"> <ResponseMetadata> <RequestId>fba800b9-3765-11df-8cf3-c58c53254dfb</RequestId> </ResponseMetadata></DeleteTopicResponse> </queryresponse></examples></param> <returns>The response from the DeleteTopic service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.DeleteTopic(Amazon.SimpleNotificationService.Model.DeleteTopicRequest)"> <summary> Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTopic service method.</param> <returns>The response from the DeleteTopic service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.DeleteTopicAsync(Amazon.SimpleNotificationService.Model.DeleteTopicRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTopic operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTopic operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.GetEndpointAttributes(Amazon.SimpleNotificationService.Model.GetEndpointAttributesRequest)"> <summary> Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetEndpointAttributes service method.</param> <returns>The response from the GetEndpointAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.GetEndpointAttributesAsync(Amazon.SimpleNotificationService.Model.GetEndpointAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetEndpointAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetEndpointAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.GetPlatformApplicationAttributes(Amazon.SimpleNotificationService.Model.GetPlatformApplicationAttributesRequest)"> <summary> Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetPlatformApplicationAttributes service method.</param> <returns>The response from the GetPlatformApplicationAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.GetPlatformApplicationAttributesAsync(Amazon.SimpleNotificationService.Model.GetPlatformApplicationAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetPlatformApplicationAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPlatformApplicationAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.GetSubscriptionAttributes(System.String)"> <summary> Returns all of the properties of a subscription. </summary> <param name="subscriptionArn">The ARN of the subscription whose properties you want to get.</param> <returns>The response from the GetSubscriptionAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.GetSubscriptionAttributes(Amazon.SimpleNotificationService.Model.GetSubscriptionAttributesRequest)"> <summary> Returns all of the properties of a subscription. </summary> <param name="request">Container for the necessary parameters to execute the GetSubscriptionAttributes service method.</param> <returns>The response from the GetSubscriptionAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.GetSubscriptionAttributesAsync(Amazon.SimpleNotificationService.Model.GetSubscriptionAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSubscriptionAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSubscriptionAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.GetTopicAttributes(System.String)"> <summary> Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. </summary> <param name="topicArn">The ARN of the topic whose properties you want to get.</param> <returns>The response from the GetTopicAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.GetTopicAttributes(Amazon.SimpleNotificationService.Model.GetTopicAttributesRequest)"> <summary> Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. </summary> <param name="request">Container for the necessary parameters to execute the GetTopicAttributes service method.</param> <returns>The response from the GetTopicAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.GetTopicAttributesAsync(Amazon.SimpleNotificationService.Model.GetTopicAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetTopicAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTopicAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListEndpointsByPlatformApplication(Amazon.SimpleNotificationService.Model.ListEndpointsByPlatformApplicationRequest)"> <summary> Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for <code>ListEndpointsByPlatformApplication</code> are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListEndpointsByPlatformApplication</code> again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the ListEndpointsByPlatformApplication service method.</param> <returns>The response from the ListEndpointsByPlatformApplication service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListEndpointsByPlatformApplicationAsync(Amazon.SimpleNotificationService.Model.ListEndpointsByPlatformApplicationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListEndpointsByPlatformApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the ListEndpointsByPlatformApplication operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListPlatformApplications"> <summary> Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for <code>ListPlatformApplications</code> are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListPlatformApplications</code> using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <returns>The response from the ListPlatformApplications service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListPlatformApplications(Amazon.SimpleNotificationService.Model.ListPlatformApplicationsRequest)"> <summary> Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for <code>ListPlatformApplications</code> are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListPlatformApplications</code> using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the ListPlatformApplications service method.</param> <returns>The response from the ListPlatformApplications service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListPlatformApplicationsAsync(Amazon.SimpleNotificationService.Model.ListPlatformApplicationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListPlatformApplications operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPlatformApplications operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListSubscriptions"> <summary> Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptions</code> call to get further results. </summary> <returns>The response from the ListSubscriptions service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListSubscriptions(System.String)"> <summary> Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptions</code> call to get further results. </summary> <param name="nextToken">Token returned by the previous <code>ListSubscriptions</code> request.</param> <returns>The response from the ListSubscriptions service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListSubscriptions(Amazon.SimpleNotificationService.Model.ListSubscriptionsRequest)"> <summary> Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptions</code> call to get further results. </summary> <param name="request">Container for the necessary parameters to execute the ListSubscriptions service method.</param> <returns>The response from the ListSubscriptions service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListSubscriptionsAsync(Amazon.SimpleNotificationService.Model.ListSubscriptionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListSubscriptions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSubscriptions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListSubscriptionsByTopic(System.String,System.String)"> <summary> Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptionsByTopic</code> call to get further results. </summary> <param name="topicArn">The ARN of the topic for which you wish to find subscriptions.</param> <param name="nextToken">Token returned by the previous <code>ListSubscriptionsByTopic</code> request.</param> <returns>The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListSubscriptionsByTopic(System.String)"> <summary> Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptionsByTopic</code> call to get further results. </summary> <param name="topicArn">The ARN of the topic for which you wish to find subscriptions.</param> <returns>The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListSubscriptionsByTopic(Amazon.SimpleNotificationService.Model.ListSubscriptionsByTopicRequest)"> <summary> Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptionsByTopic</code> call to get further results. </summary> <param name="request">Container for the necessary parameters to execute the ListSubscriptionsByTopic service method.</param> <returns>The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListSubscriptionsByTopicAsync(Amazon.SimpleNotificationService.Model.ListSubscriptionsByTopicRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListSubscriptionsByTopic operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSubscriptionsByTopic operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListTopics"> <summary> Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListTopics</code> call to get further results. </summary> <returns>The response from the ListTopics service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListTopics(System.String)"> <summary> Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListTopics</code> call to get further results. </summary> <param name="nextToken">Token returned by the previous <code>ListTopics</code> request.</param> <returns>The response from the ListTopics service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListTopics(Amazon.SimpleNotificationService.Model.ListTopicsRequest)"> <summary> Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListTopics</code> call to get further results. </summary> <param name="request">Container for the necessary parameters to execute the ListTopics service method.</param> <returns>The response from the ListTopics service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.ListTopicsAsync(Amazon.SimpleNotificationService.Model.ListTopicsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTopics operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTopics operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.Publish(System.String,System.String)"> <summary> Sends a message to all of a topic's subscribed endpoints. When a <code>messageId</code> is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected. <para> To use the <code>Publish</code> action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn. The EndpointArn is returned when making a call with the <code>CreatePlatformEndpoint</code> action. The second example below shows a request and response for publishing to a mobile endpoint. </para> </summary> <param name="topicArn">The topic you want to publish to.</param> <param name="message">The message you want to send to the topic. If you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the <code>MessageStructure</code> parameter to <code>json</code> and use a JSON object for the <code>Message</code> parameter. See the Examples section for the format of the JSON object. Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters). JSON-specific constraints: <ul> <li>Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values. </li> <li>The values will be parsed (unescaped) before they are used in outgoing messages.</li> <li>Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).</li> <li>Values have a minimum length of 0 (the empty string, "", is allowed).</li> <li>Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).</li> <li>Non-string values will cause the key to be ignored.</li> <li>Keys that do not correspond to supported transport protocols are ignored.</li> <li>Duplicate keys are not allowed.</li> <li>Failure to parse or validate any key or value in the message will cause the <code>Publish</code> call to return an error (no partial delivery).</li> </ul> </param> <returns>The response from the Publish service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.EndpointDisabledException"> Exception error indicating endpoint disabled. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterValueException"> </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.PlatformApplicationDisabledException"> Exception error indicating platform application disabled. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.Publish(System.String,System.String,System.String)"> <summary> Sends a message to all of a topic's subscribed endpoints. When a <code>messageId</code> is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected. <para> To use the <code>Publish</code> action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn. The EndpointArn is returned when making a call with the <code>CreatePlatformEndpoint</code> action. The second example below shows a request and response for publishing to a mobile endpoint. </para> </summary> <param name="topicArn">The topic you want to publish to.</param> <param name="message">The message you want to send to the topic. If you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the <code>MessageStructure</code> parameter to <code>json</code> and use a JSON object for the <code>Message</code> parameter. See the Examples section for the format of the JSON object. Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters). JSON-specific constraints: <ul> <li>Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values. </li> <li>The values will be parsed (unescaped) before they are used in outgoing messages.</li> <li>Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).</li> <li>Values have a minimum length of 0 (the empty string, "", is allowed).</li> <li>Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).</li> <li>Non-string values will cause the key to be ignored.</li> <li>Keys that do not correspond to supported transport protocols are ignored.</li> <li>Duplicate keys are not allowed.</li> <li>Failure to parse or validate any key or value in the message will cause the <code>Publish</code> call to return an error (no partial delivery).</li> </ul> </param> <param name="subject">Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.</param> <returns>The response from the Publish service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.EndpointDisabledException"> Exception error indicating endpoint disabled. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterValueException"> </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.PlatformApplicationDisabledException"> Exception error indicating platform application disabled. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.Publish(Amazon.SimpleNotificationService.Model.PublishRequest)"> <summary> Sends a message to all of a topic's subscribed endpoints. When a <code>messageId</code> is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected. <para> To use the <code>Publish</code> action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn. The EndpointArn is returned when making a call with the <code>CreatePlatformEndpoint</code> action. The second example below shows a request and response for publishing to a mobile endpoint. </para> </summary> <param name="request">Container for the necessary parameters to execute the Publish service method.</param> <returns>The response from the Publish service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.EndpointDisabledException"> Exception error indicating endpoint disabled. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterValueException"> </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.PlatformApplicationDisabledException"> Exception error indicating platform application disabled. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.PublishAsync(Amazon.SimpleNotificationService.Model.PublishRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Publish operation. </summary> <param name="request">Container for the necessary parameters to execute the Publish operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.RemovePermission(System.String,System.String)"> <summary> Removes a statement from a topic's access control policy. </summary> <param name="topicArn">The ARN of the topic whose access control policy you wish to modify.</param> <param name="label">The unique label of the statement you want to remove.</param> <returns>The response from the RemovePermission service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.RemovePermission(Amazon.SimpleNotificationService.Model.RemovePermissionRequest)"> <summary> Removes a statement from a topic's access control policy. </summary> <param name="request">Container for the necessary parameters to execute the RemovePermission service method.</param> <returns>The response from the RemovePermission service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.RemovePermissionAsync(Amazon.SimpleNotificationService.Model.RemovePermissionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemovePermission operation. </summary> <param name="request">Container for the necessary parameters to execute the RemovePermission operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.SetEndpointAttributes(Amazon.SimpleNotificationService.Model.SetEndpointAttributesRequest)"> <summary> Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the SetEndpointAttributes service method.</param> <returns>The response from the SetEndpointAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.SetEndpointAttributesAsync(Amazon.SimpleNotificationService.Model.SetEndpointAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetEndpointAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the SetEndpointAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.SetPlatformApplicationAttributes(Amazon.SimpleNotificationService.Model.SetPlatformApplicationAttributesRequest)"> <summary> Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> <param name="request">Container for the necessary parameters to execute the SetPlatformApplicationAttributes service method.</param> <returns>The response from the SetPlatformApplicationAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.SetPlatformApplicationAttributesAsync(Amazon.SimpleNotificationService.Model.SetPlatformApplicationAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetPlatformApplicationAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the SetPlatformApplicationAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.SetSubscriptionAttributes(System.String,System.String,System.String)"> <summary> Allows a subscription owner to set an attribute of the topic to a new value. </summary> <param name="subscriptionArn">The ARN of the subscription to modify.</param> <param name="attributeName">The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable. Valid values: <code>DeliveryPolicy</code> | <code>RawMessageDelivery</code></param> <param name="attributeValue">The new value for the attribute in JSON format.</param> <returns>The response from the SetSubscriptionAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.SetSubscriptionAttributes(Amazon.SimpleNotificationService.Model.SetSubscriptionAttributesRequest)"> <summary> Allows a subscription owner to set an attribute of the topic to a new value. </summary> <param name="request">Container for the necessary parameters to execute the SetSubscriptionAttributes service method.</param> <returns>The response from the SetSubscriptionAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.SetSubscriptionAttributesAsync(Amazon.SimpleNotificationService.Model.SetSubscriptionAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetSubscriptionAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the SetSubscriptionAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.SetTopicAttributes(System.String,System.String,System.String)"> <summary> Allows a topic owner to set an attribute of the topic to a new value. </summary> <param name="topicArn">The ARN of the topic to modify.</param> <param name="attributeName">The name of the attribute you want to set. Only a subset of the topic's attributes are mutable. Valid values: <code>Policy</code> | <code>DisplayName</code> | <code>DeliveryPolicy</code></param> <param name="attributeValue">The new value for the attribute.</param> <returns>The response from the SetTopicAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.SetTopicAttributes(Amazon.SimpleNotificationService.Model.SetTopicAttributesRequest)"> <summary> Allows a topic owner to set an attribute of the topic to a new value. </summary> <param name="request">Container for the necessary parameters to execute the SetTopicAttributes service method.</param> <returns>The response from the SetTopicAttributes service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.SetTopicAttributesAsync(Amazon.SimpleNotificationService.Model.SetTopicAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetTopicAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the SetTopicAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.Subscribe(System.String,System.String,System.String)"> <summary> Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the <code>ConfirmSubscription</code> action with the token from the confirmation message. Confirmation tokens are valid for three days. </summary> <param name="topicArn">The ARN of the topic you want to subscribe to.</param> <param name="protocol">The protocol you want to use. Supported protocols include: <ul> <li><code>http</code> -- delivery of JSON-encoded message via HTTP POST</li> <li><code>https</code> -- delivery of JSON-encoded message via HTTPS POST</li> <li><code>email</code> -- delivery of message via SMTP</li> <li><code>email-json</code> -- delivery of JSON-encoded message via SMTP</li> <li><code>sms</code> -- delivery of message via SMS</li> <li><code>sqs</code> -- delivery of JSON-encoded message to an Amazon SQS queue</li> <li><code>application</code> -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.</li> </ul></param> <param name="endpoint">The endpoint that you want to receive notifications. Endpoints vary by protocol: <ul> <li>For the <code>http</code> protocol, the endpoint is an URL beginning with "http://"</li> <li>For the <code>https</code> protocol, the endpoint is a URL beginning with "https://"</li> <li>For the <code>email</code> protocol, the endpoint is an email address</li> <li>For the <code>email-json</code> protocol, the endpoint is an email address</li> <li>For the <code>sms</code> protocol, the endpoint is a phone number of an SMS-enabled device</li> <li>For the <code>sqs</code> protocol, the endpoint is the ARN of an Amazon SQS queue</li> <li>For the <code>application</code> protocol, the endpoint is the EndpointArn of a mobile app and device.</li> </ul></param> <returns>The response from the Subscribe service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.SubscriptionLimitExceededException"> Indicates that the customer already owns the maximum allowed number of subscriptions. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.Subscribe(Amazon.SimpleNotificationService.Model.SubscribeRequest)"> <summary> Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the <code>ConfirmSubscription</code> action with the token from the confirmation message. Confirmation tokens are valid for three days. </summary> <param name="request">Container for the necessary parameters to execute the Subscribe service method.</param> <returns>The response from the Subscribe service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.SubscriptionLimitExceededException"> Indicates that the customer already owns the maximum allowed number of subscriptions. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.SubscribeAsync(Amazon.SimpleNotificationService.Model.SubscribeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Subscribe operation. </summary> <param name="request">Container for the necessary parameters to execute the Subscribe operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.Unsubscribe(System.String)"> <summary> Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the <code>Unsubscribe</code> call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the <code>Unsubscribe</code> request was unintended. </summary> <param name="subscriptionArn">The ARN of the subscription to be deleted.</param> <returns>The response from the Unsubscribe service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.Unsubscribe(Amazon.SimpleNotificationService.Model.UnsubscribeRequest)"> <summary> Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the <code>Unsubscribe</code> call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the <code>Unsubscribe</code> request was unintended. </summary> <param name="request">Container for the necessary parameters to execute the Unsubscribe service method.</param> <returns>The response from the Unsubscribe service method, as returned by SimpleNotificationService.</returns> <exception cref="T:Amazon.SimpleNotificationService.Model.AuthorizationErrorException"> Indicates that the user has been denied access to the requested resource. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.InvalidParameterException"> Indicates that a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.SimpleNotificationService.Model.NotFoundException"> Indicates that the requested resource does not exist. </exception> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.UnsubscribeAsync(Amazon.SimpleNotificationService.Model.UnsubscribeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the Unsubscribe operation. </summary> <param name="request">Container for the necessary parameters to execute the Unsubscribe operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.SubscribeQueue(System.String,Amazon.SQS.IAmazonSQS,System.String)"> <summary> Subscribes an existing Amazon SQS queue to an existing Amazon SNS topic. <para> The policy applied to the SQS queue is similar to this: <code> { "Version" : "2008-10-17", "Statement" : [{ "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic", "Effect" : "Allow", "Principal" : "*", "Action" : ["sqs:SendMessage"], "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"], "Condition" : { "ArnLike":{ "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"] } } }] } </code> </para> <para> There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue. </para> </summary> <param name="topicArn">The topic to subscribe to</param> <param name="sqsClient">The SQS client used to get attributes and set the policy on the SQS queue.</param> <param name="sqsQueueUrl">The queue to add a subscription to.</param> <returns>The subscription ARN as returned by Amazon SNS when the queue is successfully subscribed to the topic.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.SubscribeQueueToTopics(System.Collections.Generic.IList{System.String},Amazon.SQS.IAmazonSQS,System.String)"> <summary> Subscribes an existing Amazon SQS queue to existing Amazon SNS topics. <para> The policy applied to the SQS queue is similar to this: <code> { "Version" : "2008-10-17", "Statement" : [{ "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic", "Effect" : "Allow", "Principal" : "*", "Action" : ["sqs:SendMessage"], "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"], "Condition" : { "ArnLike":{ "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"] } } }] } </code> </para> <para> There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue. </para> </summary> <param name="topicArns">The topics to subscribe to</param> <param name="sqsClient">The SQS client used to get attributes and set the policy on the SQS queue.</param> <param name="sqsQueueUrl">The queue to add a subscription to.</param> <returns>The mapping of topic ARNs to subscription ARNs as returned by Amazon SNS when the queue is successfully subscribed to each topic.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AddSQSPermission(Amazon.Auth.AccessControlPolicy.Policy,System.String,System.String)"> <summary> Add statement to the policy that gives the sns topic access to send a message to the queue. </summary> <param name="policy"></param> <param name="topicArn"></param> <param name="sqsQueueArn"></param> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.HasSQSPermission(Amazon.Auth.AccessControlPolicy.Policy,System.String,System.String)"> <summary> Check to see if the policy for the queue has already given permission to the topic. </summary> <param name="policy"></param> <param name="topicArn"></param> <param name="sqsQueueArn"></param> <returns></returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.FindTopic(System.String)"> <summary> Finds an existing Amazon SNS topic by iterating all SNS topics until a match is found. <para> The ListTopics method is used to fetch upto 100 SNS topics at a time until a SNS topic with an TopicArn that matches <paramref name="topicName"/> is found. </para> </summary> <param name="topicName">The name of the topic find</param> <returns>The matched SNS topic.</returns> </member> <member name="M:Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(System.String,System.String)"> <summary> This is a utility method which updates the policy of a topic to allow the S3 bucket to publish events to it. </summary> <param name="topicArn">The topic that will have its policy updated.</param> <param name="bucket">The bucket that will be given access to publish from.</param> </member> <member name="T:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient"> <summary> Implementation for accessing SimpleSystemsManagement Simple Systems Manager (SSM) enables you to remotely manage the configuration of your Amazon EC2 instance. Using SSM, you can run scripts or commands using either EC2 Run Command or SSM Config. (SSM Config is currently available only for Windows instances.) <b>Run Command</b> <para> Run Command provides an on-demand experience for executing commands. You can use pre-defined Amazon SSM documents to perform the actions listed later in this section, or you can create your own documents. With these documents, you can remotely configure your instances by sending commands using the <b>Commands</b> page in the <a href="http://console.aws.amazon.com/ec2/">Amazon EC2 console</a>, <a href="http://docs.aws.amazon.com/powershell/latest/reference/items/Amazon_Simple_Systems_Management_cmdlets.html">AWS Tools for Windows PowerShell</a>, or the <a href="http://docs.aws.amazon.com/cli/latest/reference/ssm/index.html">AWS CLI</a>. </para> <para> Run Command reports the status of the command execution for each instance targeted by a command. You can also audit the command execution to understand who executed commands, when, and what changes were made. By switching between different SSM documents, you can quickly configure your instances with different types of commands. To get started with Run Command, verify that your environment meets the prerequisites for remotely running commands on EC2 instances (<a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/remote-commands-prereq.html">Linux</a> or <a href="http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/remote-commands-prereq.html">Windows</a>). </para> <b>SSM Config</b> <para> SSM Config is a lightweight instance configuration solution. SSM Config is currently only available for Windows instances. With SSM Config, you can specify a setup configuration for your instances. SSM Config is similar to EC2 User Data, which is another way of running one-time scripts or applying settings during instance launch. SSM Config is an extension of this capability. Using SSM documents, you can specify which actions the system should perform on your instances, including which applications to install, which AWS Directory Service directory to join, which Microsoft PowerShell modules to install, etc. If an instance is missing one or more of these configurations, the system makes those changes. By default, the system checks every five minutes to see if there is a new configuration to apply as defined in a new SSM document. If so, the system updates the instances accordingly. In this way, you can remotely maintain a consistent configuration baseline on your instances. SSM Config is available using the AWS CLI or the AWS Tools for Windows PowerShell. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-configuration-manage.html">Managing Windows Instance Configuration</a>. </para> <para> SSM Config and Run Command include the following pre-defined documents. </para> <table> <title>Amazon Pre-defined SSM Documents</title> <tgroup cols="3"> <colspec colname="col1" colnum="1" colwidth="1*"/> <colspec colname="col2" colnum="2" colwidth="1*"/> <colspec colname="col3" colnum="3" colwidth="1*"/> <thead> <row> <entry>Name</entry> <entry>Description</entry> <entry>Platform</entry> </row> </thead> <tbody> <row> <entry> <para> AWS-RunShellScript </para> </entry> <entry> <para> Run shell scripts </para> </entry> <entry> <para> Linux </para> </entry> </row> <row> <entry> <para> AWS-UpdateSSMAgent </para> </entry> <entry> <para> Update the Amazon SSM agent </para> </entry> <entry> <para> Linux </para> </entry> </row> <row> <entry> <para> AWS-JoinDirectoryServiceDomain </para> </entry> <entry> <para> Join an AWS Directory </para> </entry> <entry> <para> Windows </para> </entry> </row> <row> <entry> <para> AWS-RunPowerShellScript </para> </entry> <entry> <para> Run PowerShell commands or scripts </para> </entry> <entry> <para> Windows </para> </entry> </row> <row> <entry> <para> AWS-UpdateEC2Config </para> </entry> <entry> <para> Update the EC2Config service </para> </entry> <entry> <para> Windows </para> </entry> </row> <row> <entry> <para> AWS-ConfigureWindowsUpdate </para> </entry> <entry> <para> Configure Windows Update settings </para> </entry> <entry> <para> Windows </para> </entry> </row> <row> <entry> <para> AWS-InstallApplication </para> </entry> <entry> <para> Install, repair, or uninstall software using an MSI package </para> </entry> <entry> <para> Windows </para> </entry> </row> <row> <entry> <para> AWS-InstallPowerShellModule </para> </entry> <entry> <para> Install PowerShell modules </para> </entry> <entry> <para> Windows </para> </entry> </row> <row> <entry> <para> AWS-ConfigureCloudWatch </para> </entry> <entry> <para> Configure Amazon CloudWatch Logs to monitor applications and systems </para> </entry> <entry> <para> Windows </para> </entry> </row> </tbody> </tgroup> </table> <important> <simpara>The commands or scripts specified in SSM documents run with administrative privilege on your instances because the Amazon SSM agent runs as root on Linux and the EC2Config service runs in the Local System account on Windows. If a user has permission to execute any of the pre-defined SSM documents (any document that begins with AWS-*) then that user also has administrator access to the instance. Delegate access to SSM and Run Command judiciously. This becomes extremely important if you create your own SSM documents. Amazon Web Services does not provide guidance about how to create secure SSM documents. You create SSM documents and delegate access to Run Command at your own risk. As a security best practice, we recommend that you assign access to "AWS-*" documents, especially the AWS-RunShellScript document on Linux and the AWS-RunPowerShellScript document on Windows, to trusted administrators only. You can create SSM documents for specific tasks and delegate access to non-administrators.</simpara> </important> </summary> </member> <member name="T:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement"> <summary> Interface for accessing SimpleSystemsManagement Simple Systems Manager (SSM) enables you to remotely manage the configuration of your Amazon EC2 instance. Using SSM, you can run scripts or commands using either EC2 Run Command or SSM Config. (SSM Config is currently available only for Windows instances.) <b>Run Command</b> <para> Run Command provides an on-demand experience for executing commands. You can use pre-defined Amazon SSM documents to perform the actions listed later in this section, or you can create your own documents. With these documents, you can remotely configure your instances by sending commands using the <b>Commands</b> page in the <a href="http://console.aws.amazon.com/ec2/">Amazon EC2 console</a>, <a href="http://docs.aws.amazon.com/powershell/latest/reference/items/Amazon_Simple_Systems_Management_cmdlets.html">AWS Tools for Windows PowerShell</a>, or the <a href="http://docs.aws.amazon.com/cli/latest/reference/ssm/index.html">AWS CLI</a>. </para> <para> Run Command reports the status of the command execution for each instance targeted by a command. You can also audit the command execution to understand who executed commands, when, and what changes were made. By switching between different SSM documents, you can quickly configure your instances with different types of commands. To get started with Run Command, verify that your environment meets the prerequisites for remotely running commands on EC2 instances (<a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/remote-commands-prereq.html">Linux</a> or <a href="http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/remote-commands-prereq.html">Windows</a>). </para> <b>SSM Config</b> <para> SSM Config is a lightweight instance configuration solution. SSM Config is currently only available for Windows instances. With SSM Config, you can specify a setup configuration for your instances. SSM Config is similar to EC2 User Data, which is another way of running one-time scripts or applying settings during instance launch. SSM Config is an extension of this capability. Using SSM documents, you can specify which actions the system should perform on your instances, including which applications to install, which AWS Directory Service directory to join, which Microsoft PowerShell modules to install, etc. If an instance is missing one or more of these configurations, the system makes those changes. By default, the system checks every five minutes to see if there is a new configuration to apply as defined in a new SSM document. If so, the system updates the instances accordingly. In this way, you can remotely maintain a consistent configuration baseline on your instances. SSM Config is available using the AWS CLI or the AWS Tools for Windows PowerShell. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-configuration-manage.html">Managing Windows Instance Configuration</a>. </para> <para> SSM Config and Run Command include the following pre-defined documents. </para> <table> <title>Amazon Pre-defined SSM Documents</title> <tgroup cols="3"> <colspec colname="col1" colnum="1" colwidth="1*"/> <colspec colname="col2" colnum="2" colwidth="1*"/> <colspec colname="col3" colnum="3" colwidth="1*"/> <thead> <row> <entry>Name</entry> <entry>Description</entry> <entry>Platform</entry> </row> </thead> <tbody> <row> <entry> <para> AWS-RunShellScript </para> </entry> <entry> <para> Run shell scripts </para> </entry> <entry> <para> Linux </para> </entry> </row> <row> <entry> <para> AWS-UpdateSSMAgent </para> </entry> <entry> <para> Update the Amazon SSM agent </para> </entry> <entry> <para> Linux </para> </entry> </row> <row> <entry> <para> AWS-JoinDirectoryServiceDomain </para> </entry> <entry> <para> Join an AWS Directory </para> </entry> <entry> <para> Windows </para> </entry> </row> <row> <entry> <para> AWS-RunPowerShellScript </para> </entry> <entry> <para> Run PowerShell commands or scripts </para> </entry> <entry> <para> Windows </para> </entry> </row> <row> <entry> <para> AWS-UpdateEC2Config </para> </entry> <entry> <para> Update the EC2Config service </para> </entry> <entry> <para> Windows </para> </entry> </row> <row> <entry> <para> AWS-ConfigureWindowsUpdate </para> </entry> <entry> <para> Configure Windows Update settings </para> </entry> <entry> <para> Windows </para> </entry> </row> <row> <entry> <para> AWS-InstallApplication </para> </entry> <entry> <para> Install, repair, or uninstall software using an MSI package </para> </entry> <entry> <para> Windows </para> </entry> </row> <row> <entry> <para> AWS-InstallPowerShellModule </para> </entry> <entry> <para> Install PowerShell modules </para> </entry> <entry> <para> Windows </para> </entry> </row> <row> <entry> <para> AWS-ConfigureCloudWatch </para> </entry> <entry> <para> Configure Amazon CloudWatch Logs to monitor applications and systems </para> </entry> <entry> <para> Windows </para> </entry> </row> </tbody> </tgroup> </table> <important> <simpara>The commands or scripts specified in SSM documents run with administrative privilege on your instances because the Amazon SSM agent runs as root on Linux and the EC2Config service runs in the Local System account on Windows. If a user has permission to execute any of the pre-defined SSM documents (any document that begins with AWS-*) then that user also has administrator access to the instance. Delegate access to SSM and Run Command judiciously. This becomes extremely important if you create your own SSM documents. Amazon Web Services does not provide guidance about how to create secure SSM documents. You create SSM documents and delegate access to Run Command at your own risk. As a security best practice, we recommend that you assign access to "AWS-*" documents, especially the AWS-RunShellScript document on Linux and the AWS-RunPowerShellScript document on Windows, to trusted administrators only. You can create SSM documents for specific tasks and delegate access to non-administrators.</simpara> </important> </summary> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.CancelCommand(System.String)"> <summary> Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped. </summary> <param name="commandId">The ID of the command you want to cancel.</param> <returns>The response from the CancelCommand service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DuplicateInstanceIdException"> You cannot specify an instance ID in more than one association. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.CancelCommand(System.String,System.Collections.Generic.List{System.String})"> <summary> Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped. </summary> <param name="commandId">The ID of the command you want to cancel.</param> <param name="instanceIds">(Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.</param> <returns>The response from the CancelCommand service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DuplicateInstanceIdException"> You cannot specify an instance ID in more than one association. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.CancelCommand(Amazon.SimpleSystemsManagement.Model.CancelCommandRequest)"> <summary> Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped. </summary> <param name="request">Container for the necessary parameters to execute the CancelCommand service method.</param> <returns>The response from the CancelCommand service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DuplicateInstanceIdException"> You cannot specify an instance ID in more than one association. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.CancelCommandAsync(Amazon.SimpleSystemsManagement.Model.CancelCommandRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelCommand operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelCommand operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.CreateAssociation(System.String,System.String)"> <summary> Associates the specified SSM document with the specified instance. <para> When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified. </para> <para> If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception. </para> </summary> <param name="instanceId">The Windows Server instance ID.</param> <param name="name">The name of the SSM document.</param> <returns>The response from the CreateAssociation service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationAlreadyExistsException"> The specified association already exists. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationLimitExceededException"> You can have at most 2,000 active associations. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidParametersException"> You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.UnsupportedPlatformTypeException"> The document does not support the platform type of the given instance ID(s). </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.CreateAssociation(Amazon.SimpleSystemsManagement.Model.CreateAssociationRequest)"> <summary> Associates the specified SSM document with the specified instance. <para> When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified. </para> <para> If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateAssociation service method.</param> <returns>The response from the CreateAssociation service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationAlreadyExistsException"> The specified association already exists. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationLimitExceededException"> You can have at most 2,000 active associations. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidParametersException"> You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.UnsupportedPlatformTypeException"> The document does not support the platform type of the given instance ID(s). </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.CreateAssociationAsync(Amazon.SimpleSystemsManagement.Model.CreateAssociationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAssociation operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAssociation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.CreateAssociationBatch(Amazon.SimpleSystemsManagement.Model.CreateAssociationBatchRequest)"> <summary> Associates the specified SSM document with the specified instances. <para> When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified. </para> <para> If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateAssociationBatch service method.</param> <returns>The response from the CreateAssociationBatch service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationLimitExceededException"> You can have at most 2,000 active associations. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DuplicateInstanceIdException"> You cannot specify an instance ID in more than one association. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidParametersException"> You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.UnsupportedPlatformTypeException"> The document does not support the platform type of the given instance ID(s). </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.CreateAssociationBatchAsync(Amazon.SimpleSystemsManagement.Model.CreateAssociationBatchRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAssociationBatch operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAssociationBatch operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.CreateDocument(System.String,System.String)"> <summary> Creates an SSM document. <para> After you create an SSM document, you can use <a>CreateAssociation</a> to associate it with one or more running instances. </para> </summary> <param name="content">A valid JSON string. For more information about the contents of this string, see <a href="http://docs.aws.amazon.com/ssm/latest/APIReference/aws-ssm-document.html">SSM Document</a>.</param> <param name="name">A name for the SSM document.</param> <returns>The response from the CreateDocument service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DocumentAlreadyExistsException"> The specified SSM document already exists. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DocumentLimitExceededException"> You can have at most 100 active SSM documents. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentContentException"> The content for the SSM document is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.MaxDocumentSizeExceededException"> The size limit of an SSM document is 64 KB. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.CreateDocument(Amazon.SimpleSystemsManagement.Model.CreateDocumentRequest)"> <summary> Creates an SSM document. <para> After you create an SSM document, you can use <a>CreateAssociation</a> to associate it with one or more running instances. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDocument service method.</param> <returns>The response from the CreateDocument service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DocumentAlreadyExistsException"> The specified SSM document already exists. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DocumentLimitExceededException"> You can have at most 100 active SSM documents. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentContentException"> The content for the SSM document is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.MaxDocumentSizeExceededException"> The size limit of an SSM document is 64 KB. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.CreateDocumentAsync(Amazon.SimpleSystemsManagement.Model.CreateDocumentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDocument operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDocument operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.DeleteAssociation(System.String,System.String)"> <summary> Disassociates the specified SSM document from the specified instance. <para> When you disassociate an SSM document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance. </para> </summary> <param name="instanceId">The ID of the instance.</param> <param name="name">The name of the SSM document.</param> <returns>The response from the DeleteAssociation service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationDoesNotExistException"> The specified association does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.TooManyUpdatesException"> There are concurrent updates for a resource that supports one update at a time. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.DeleteAssociation(Amazon.SimpleSystemsManagement.Model.DeleteAssociationRequest)"> <summary> Disassociates the specified SSM document from the specified instance. <para> When you disassociate an SSM document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAssociation service method.</param> <returns>The response from the DeleteAssociation service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationDoesNotExistException"> The specified association does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.TooManyUpdatesException"> There are concurrent updates for a resource that supports one update at a time. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.DeleteAssociationAsync(Amazon.SimpleSystemsManagement.Model.DeleteAssociationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAssociation operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAssociation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.DeleteDocument(System.String)"> <summary> Deletes the SSM document and all instance associations to the document. <para> Before you delete the SSM document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document. </para> </summary> <param name="name">The name of the SSM document.</param> <returns>The response from the DeleteDocument service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociatedInstancesException"> You must disassociate an SSM document from all instances before you can delete it. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.DeleteDocument(Amazon.SimpleSystemsManagement.Model.DeleteDocumentRequest)"> <summary> Deletes the SSM document and all instance associations to the document. <para> Before you delete the SSM document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDocument service method.</param> <returns>The response from the DeleteDocument service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociatedInstancesException"> You must disassociate an SSM document from all instances before you can delete it. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.DeleteDocumentAsync(Amazon.SimpleSystemsManagement.Model.DeleteDocumentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDocument operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDocument operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.DescribeAssociation(System.String,System.String)"> <summary> Describes the associations for the specified SSM document or instance. </summary> <param name="instanceId">The Windows Server instance ID.</param> <param name="name">The name of the SSM document.</param> <returns>The response from the DescribeAssociation service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationDoesNotExistException"> The specified association does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.DescribeAssociation(Amazon.SimpleSystemsManagement.Model.DescribeAssociationRequest)"> <summary> Describes the associations for the specified SSM document or instance. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAssociation service method.</param> <returns>The response from the DescribeAssociation service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationDoesNotExistException"> The specified association does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.DescribeAssociationAsync(Amazon.SimpleSystemsManagement.Model.DescribeAssociationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAssociation operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAssociation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.DescribeDocument(System.String)"> <summary> Describes the specified SSM document. </summary> <param name="name">The name of the SSM document.</param> <returns>The response from the DescribeDocument service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.DescribeDocument(Amazon.SimpleSystemsManagement.Model.DescribeDocumentRequest)"> <summary> Describes the specified SSM document. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDocument service method.</param> <returns>The response from the DescribeDocument service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.DescribeDocumentAsync(Amazon.SimpleSystemsManagement.Model.DescribeDocumentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDocument operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDocument operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.DescribeInstanceInformation"> <summary> Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM agent version, status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error. </summary> <returns>The response from the DescribeInstanceInformation service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceInformationFilterValueException"> The specified filter value is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.DescribeInstanceInformation(Amazon.SimpleSystemsManagement.Model.DescribeInstanceInformationRequest)"> <summary> Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM agent version, status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceInformation service method.</param> <returns>The response from the DescribeInstanceInformation service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceInformationFilterValueException"> The specified filter value is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.DescribeInstanceInformationAsync(Amazon.SimpleSystemsManagement.Model.DescribeInstanceInformationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInstanceInformation operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceInformation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.GetDocument(System.String)"> <summary> Gets the contents of the specified SSM document. </summary> <param name="name">The name of the SSM document.</param> <returns>The response from the GetDocument service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.GetDocument(Amazon.SimpleSystemsManagement.Model.GetDocumentRequest)"> <summary> Gets the contents of the specified SSM document. </summary> <param name="request">Container for the necessary parameters to execute the GetDocument service method.</param> <returns>The response from the GetDocument service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.GetDocumentAsync(Amazon.SimpleSystemsManagement.Model.GetDocumentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDocument operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDocument operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.ListAssociations(Amazon.SimpleSystemsManagement.Model.ListAssociationsRequest)"> <summary> Lists the associations for the specified SSM document or instance. </summary> <param name="request">Container for the necessary parameters to execute the ListAssociations service method.</param> <returns>The response from the ListAssociations service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.ListAssociationsAsync(Amazon.SimpleSystemsManagement.Model.ListAssociationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAssociations operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAssociations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.ListCommandInvocations"> <summary> An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution. </summary> <returns>The response from the ListCommandInvocations service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.ListCommandInvocations(System.String)"> <summary> An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution. </summary> <param name="commandId">(Optional) The invocations for a specific command ID.</param> <returns>The response from the ListCommandInvocations service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.ListCommandInvocations(Amazon.SimpleSystemsManagement.Model.ListCommandInvocationsRequest)"> <summary> An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution. </summary> <param name="request">Container for the necessary parameters to execute the ListCommandInvocations service method.</param> <returns>The response from the ListCommandInvocations service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.ListCommandInvocationsAsync(Amazon.SimpleSystemsManagement.Model.ListCommandInvocationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListCommandInvocations operation. </summary> <param name="request">Container for the necessary parameters to execute the ListCommandInvocations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.ListCommands"> <summary> Lists the commands requested by users of the AWS account. </summary> <returns>The response from the ListCommands service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.ListCommands(System.String)"> <summary> Lists the commands requested by users of the AWS account. </summary> <param name="commandId">(Optional) If provided, lists only the specified command.</param> <returns>The response from the ListCommands service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.ListCommands(Amazon.SimpleSystemsManagement.Model.ListCommandsRequest)"> <summary> Lists the commands requested by users of the AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListCommands service method.</param> <returns>The response from the ListCommands service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.ListCommandsAsync(Amazon.SimpleSystemsManagement.Model.ListCommandsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListCommands operation. </summary> <param name="request">Container for the necessary parameters to execute the ListCommands operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.ListDocuments"> <summary> Describes one or more of your SSM documents. </summary> <returns>The response from the ListDocuments service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.ListDocuments(Amazon.SimpleSystemsManagement.Model.ListDocumentsRequest)"> <summary> Describes one or more of your SSM documents. </summary> <param name="request">Container for the necessary parameters to execute the ListDocuments service method.</param> <returns>The response from the ListDocuments service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.ListDocumentsAsync(Amazon.SimpleSystemsManagement.Model.ListDocumentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDocuments operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDocuments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.SendCommand(System.String,System.Collections.Generic.List{System.String})"> <summary> Executes commands on one or more remote instances. </summary> <param name="documentName">Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.</param> <param name="instanceIds">Required. The instance IDs where the command should execute.</param> <returns>The response from the SendCommand service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DuplicateInstanceIdException"> You cannot specify an instance ID in more than one association. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidOutputFolderException"> The S3 bucket does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidParametersException"> You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.UnsupportedPlatformTypeException"> The document does not support the platform type of the given instance ID(s). </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.SendCommand(Amazon.SimpleSystemsManagement.Model.SendCommandRequest)"> <summary> Executes commands on one or more remote instances. </summary> <param name="request">Container for the necessary parameters to execute the SendCommand service method.</param> <returns>The response from the SendCommand service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DuplicateInstanceIdException"> You cannot specify an instance ID in more than one association. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidOutputFolderException"> The S3 bucket does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidParametersException"> You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.UnsupportedPlatformTypeException"> The document does not support the platform type of the given instance ID(s). </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.SendCommandAsync(Amazon.SimpleSystemsManagement.Model.SendCommandRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SendCommand operation. </summary> <param name="request">Container for the necessary parameters to execute the SendCommand operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.UpdateAssociationStatus(Amazon.SimpleSystemsManagement.Model.UpdateAssociationStatusRequest)"> <summary> Updates the status of the SSM document associated with the specified instance. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAssociationStatus service method.</param> <returns>The response from the UpdateAssociationStatus service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationDoesNotExistException"> The specified association does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.StatusUnchangedException"> The updated status is the same as the current status. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.TooManyUpdatesException"> There are concurrent updates for a resource that supports one update at a time. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.IAmazonSimpleSystemsManagement.UpdateAssociationStatusAsync(Amazon.SimpleSystemsManagement.Model.UpdateAssociationStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAssociationStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAssociationStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.#ctor"> <summary> Constructs AmazonSimpleSystemsManagementClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleSystemsManagementClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.#ctor(Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementConfig)"> <summary> Constructs AmazonSimpleSystemsManagementClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonSimpleSystemsManagementClient Configuration Object</param> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonSimpleSystemsManagementClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleSystemsManagementClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementConfig)"> <summary> Constructs AmazonSimpleSystemsManagementClient with AWS Credentials and an AmazonSimpleSystemsManagementClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonSimpleSystemsManagementClient Configuration Object</param> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.#ctor(System.String,System.String,Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementConfig)"> <summary> Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleSystemsManagementClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonSimpleSystemsManagementClient Configuration Object</param> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.#ctor(System.String,System.String,System.String,Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementConfig)"> <summary> Constructs AmazonSimpleSystemsManagementClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleSystemsManagementClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonSimpleSystemsManagementClient Configuration Object</param> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.CancelCommand(System.String)"> <summary> Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped. </summary> <param name="commandId">The ID of the command you want to cancel.</param> <returns>The response from the CancelCommand service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DuplicateInstanceIdException"> You cannot specify an instance ID in more than one association. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.CancelCommand(System.String,System.Collections.Generic.List{System.String})"> <summary> Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped. </summary> <param name="commandId">The ID of the command you want to cancel.</param> <param name="instanceIds">(Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.</param> <returns>The response from the CancelCommand service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DuplicateInstanceIdException"> You cannot specify an instance ID in more than one association. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.CancelCommand(Amazon.SimpleSystemsManagement.Model.CancelCommandRequest)"> <summary> Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped. </summary> <param name="request">Container for the necessary parameters to execute the CancelCommand service method.</param> <returns>The response from the CancelCommand service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DuplicateInstanceIdException"> You cannot specify an instance ID in more than one association. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.CancelCommandAsync(Amazon.SimpleSystemsManagement.Model.CancelCommandRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelCommand operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelCommand operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.CreateAssociation(System.String,System.String)"> <summary> Associates the specified SSM document with the specified instance. <para> When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified. </para> <para> If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception. </para> </summary> <param name="instanceId">The Windows Server instance ID.</param> <param name="name">The name of the SSM document.</param> <returns>The response from the CreateAssociation service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationAlreadyExistsException"> The specified association already exists. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationLimitExceededException"> You can have at most 2,000 active associations. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidParametersException"> You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.UnsupportedPlatformTypeException"> The document does not support the platform type of the given instance ID(s). </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.CreateAssociation(Amazon.SimpleSystemsManagement.Model.CreateAssociationRequest)"> <summary> Associates the specified SSM document with the specified instance. <para> When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified. </para> <para> If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateAssociation service method.</param> <returns>The response from the CreateAssociation service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationAlreadyExistsException"> The specified association already exists. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationLimitExceededException"> You can have at most 2,000 active associations. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidParametersException"> You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.UnsupportedPlatformTypeException"> The document does not support the platform type of the given instance ID(s). </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.CreateAssociationAsync(Amazon.SimpleSystemsManagement.Model.CreateAssociationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAssociation operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAssociation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.CreateAssociationBatch(Amazon.SimpleSystemsManagement.Model.CreateAssociationBatchRequest)"> <summary> Associates the specified SSM document with the specified instances. <para> When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified. </para> <para> If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateAssociationBatch service method.</param> <returns>The response from the CreateAssociationBatch service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationLimitExceededException"> You can have at most 2,000 active associations. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DuplicateInstanceIdException"> You cannot specify an instance ID in more than one association. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidParametersException"> You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.UnsupportedPlatformTypeException"> The document does not support the platform type of the given instance ID(s). </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.CreateAssociationBatchAsync(Amazon.SimpleSystemsManagement.Model.CreateAssociationBatchRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateAssociationBatch operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAssociationBatch operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.CreateDocument(System.String,System.String)"> <summary> Creates an SSM document. <para> After you create an SSM document, you can use <a>CreateAssociation</a> to associate it with one or more running instances. </para> </summary> <param name="content">A valid JSON string. For more information about the contents of this string, see <a href="http://docs.aws.amazon.com/ssm/latest/APIReference/aws-ssm-document.html">SSM Document</a>.</param> <param name="name">A name for the SSM document.</param> <returns>The response from the CreateDocument service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DocumentAlreadyExistsException"> The specified SSM document already exists. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DocumentLimitExceededException"> You can have at most 100 active SSM documents. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentContentException"> The content for the SSM document is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.MaxDocumentSizeExceededException"> The size limit of an SSM document is 64 KB. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.CreateDocument(Amazon.SimpleSystemsManagement.Model.CreateDocumentRequest)"> <summary> Creates an SSM document. <para> After you create an SSM document, you can use <a>CreateAssociation</a> to associate it with one or more running instances. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDocument service method.</param> <returns>The response from the CreateDocument service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DocumentAlreadyExistsException"> The specified SSM document already exists. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DocumentLimitExceededException"> You can have at most 100 active SSM documents. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentContentException"> The content for the SSM document is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.MaxDocumentSizeExceededException"> The size limit of an SSM document is 64 KB. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.CreateDocumentAsync(Amazon.SimpleSystemsManagement.Model.CreateDocumentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateDocument operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDocument operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.DeleteAssociation(System.String,System.String)"> <summary> Disassociates the specified SSM document from the specified instance. <para> When you disassociate an SSM document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance. </para> </summary> <param name="instanceId">The ID of the instance.</param> <param name="name">The name of the SSM document.</param> <returns>The response from the DeleteAssociation service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationDoesNotExistException"> The specified association does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.TooManyUpdatesException"> There are concurrent updates for a resource that supports one update at a time. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.DeleteAssociation(Amazon.SimpleSystemsManagement.Model.DeleteAssociationRequest)"> <summary> Disassociates the specified SSM document from the specified instance. <para> When you disassociate an SSM document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAssociation service method.</param> <returns>The response from the DeleteAssociation service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationDoesNotExistException"> The specified association does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.TooManyUpdatesException"> There are concurrent updates for a resource that supports one update at a time. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.DeleteAssociationAsync(Amazon.SimpleSystemsManagement.Model.DeleteAssociationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteAssociation operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAssociation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.DeleteDocument(System.String)"> <summary> Deletes the SSM document and all instance associations to the document. <para> Before you delete the SSM document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document. </para> </summary> <param name="name">The name of the SSM document.</param> <returns>The response from the DeleteDocument service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociatedInstancesException"> You must disassociate an SSM document from all instances before you can delete it. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.DeleteDocument(Amazon.SimpleSystemsManagement.Model.DeleteDocumentRequest)"> <summary> Deletes the SSM document and all instance associations to the document. <para> Before you delete the SSM document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDocument service method.</param> <returns>The response from the DeleteDocument service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociatedInstancesException"> You must disassociate an SSM document from all instances before you can delete it. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.DeleteDocumentAsync(Amazon.SimpleSystemsManagement.Model.DeleteDocumentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteDocument operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDocument operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.DescribeAssociation(System.String,System.String)"> <summary> Describes the associations for the specified SSM document or instance. </summary> <param name="instanceId">The Windows Server instance ID.</param> <param name="name">The name of the SSM document.</param> <returns>The response from the DescribeAssociation service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationDoesNotExistException"> The specified association does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.DescribeAssociation(Amazon.SimpleSystemsManagement.Model.DescribeAssociationRequest)"> <summary> Describes the associations for the specified SSM document or instance. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAssociation service method.</param> <returns>The response from the DescribeAssociation service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationDoesNotExistException"> The specified association does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.DescribeAssociationAsync(Amazon.SimpleSystemsManagement.Model.DescribeAssociationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeAssociation operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAssociation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.DescribeDocument(System.String)"> <summary> Describes the specified SSM document. </summary> <param name="name">The name of the SSM document.</param> <returns>The response from the DescribeDocument service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.DescribeDocument(Amazon.SimpleSystemsManagement.Model.DescribeDocumentRequest)"> <summary> Describes the specified SSM document. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDocument service method.</param> <returns>The response from the DescribeDocument service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.DescribeDocumentAsync(Amazon.SimpleSystemsManagement.Model.DescribeDocumentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDocument operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDocument operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.DescribeInstanceInformation"> <summary> Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM agent version, status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error. </summary> <returns>The response from the DescribeInstanceInformation service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceInformationFilterValueException"> The specified filter value is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.DescribeInstanceInformation(Amazon.SimpleSystemsManagement.Model.DescribeInstanceInformationRequest)"> <summary> Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM agent version, status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceInformation service method.</param> <returns>The response from the DescribeInstanceInformation service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceInformationFilterValueException"> The specified filter value is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.DescribeInstanceInformationAsync(Amazon.SimpleSystemsManagement.Model.DescribeInstanceInformationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeInstanceInformation operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceInformation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.GetDocument(System.String)"> <summary> Gets the contents of the specified SSM document. </summary> <param name="name">The name of the SSM document.</param> <returns>The response from the GetDocument service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.GetDocument(Amazon.SimpleSystemsManagement.Model.GetDocumentRequest)"> <summary> Gets the contents of the specified SSM document. </summary> <param name="request">Container for the necessary parameters to execute the GetDocument service method.</param> <returns>The response from the GetDocument service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.GetDocumentAsync(Amazon.SimpleSystemsManagement.Model.GetDocumentRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetDocument operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDocument operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.ListAssociations(Amazon.SimpleSystemsManagement.Model.ListAssociationsRequest)"> <summary> Lists the associations for the specified SSM document or instance. </summary> <param name="request">Container for the necessary parameters to execute the ListAssociations service method.</param> <returns>The response from the ListAssociations service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.ListAssociationsAsync(Amazon.SimpleSystemsManagement.Model.ListAssociationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListAssociations operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAssociations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.ListCommandInvocations"> <summary> An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution. </summary> <returns>The response from the ListCommandInvocations service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.ListCommandInvocations(System.String)"> <summary> An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution. </summary> <param name="commandId">(Optional) The invocations for a specific command ID.</param> <returns>The response from the ListCommandInvocations service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.ListCommandInvocations(Amazon.SimpleSystemsManagement.Model.ListCommandInvocationsRequest)"> <summary> An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution. </summary> <param name="request">Container for the necessary parameters to execute the ListCommandInvocations service method.</param> <returns>The response from the ListCommandInvocations service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.ListCommandInvocationsAsync(Amazon.SimpleSystemsManagement.Model.ListCommandInvocationsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListCommandInvocations operation. </summary> <param name="request">Container for the necessary parameters to execute the ListCommandInvocations operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.ListCommands"> <summary> Lists the commands requested by users of the AWS account. </summary> <returns>The response from the ListCommands service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.ListCommands(System.String)"> <summary> Lists the commands requested by users of the AWS account. </summary> <param name="commandId">(Optional) If provided, lists only the specified command.</param> <returns>The response from the ListCommands service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.ListCommands(Amazon.SimpleSystemsManagement.Model.ListCommandsRequest)"> <summary> Lists the commands requested by users of the AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListCommands service method.</param> <returns>The response from the ListCommands service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidCommandIdException"> </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.ListCommandsAsync(Amazon.SimpleSystemsManagement.Model.ListCommandsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListCommands operation. </summary> <param name="request">Container for the necessary parameters to execute the ListCommands operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.ListDocuments"> <summary> Describes one or more of your SSM documents. </summary> <returns>The response from the ListDocuments service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.ListDocuments(Amazon.SimpleSystemsManagement.Model.ListDocumentsRequest)"> <summary> Describes one or more of your SSM documents. </summary> <param name="request">Container for the necessary parameters to execute the ListDocuments service method.</param> <returns>The response from the ListDocuments service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidFilterKeyException"> The specified key is not valid. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidNextTokenException"> The specified token is not valid. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.ListDocumentsAsync(Amazon.SimpleSystemsManagement.Model.ListDocumentsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDocuments operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDocuments operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.SendCommand(System.String,System.Collections.Generic.List{System.String})"> <summary> Executes commands on one or more remote instances. </summary> <param name="documentName">Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.</param> <param name="instanceIds">Required. The instance IDs where the command should execute.</param> <returns>The response from the SendCommand service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DuplicateInstanceIdException"> You cannot specify an instance ID in more than one association. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidOutputFolderException"> The S3 bucket does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidParametersException"> You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.UnsupportedPlatformTypeException"> The document does not support the platform type of the given instance ID(s). </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.SendCommand(Amazon.SimpleSystemsManagement.Model.SendCommandRequest)"> <summary> Executes commands on one or more remote instances. </summary> <param name="request">Container for the necessary parameters to execute the SendCommand service method.</param> <returns>The response from the SendCommand service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.DuplicateInstanceIdException"> You cannot specify an instance ID in more than one association. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidOutputFolderException"> The S3 bucket does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidParametersException"> You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.UnsupportedPlatformTypeException"> The document does not support the platform type of the given instance ID(s). </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.SendCommandAsync(Amazon.SimpleSystemsManagement.Model.SendCommandRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SendCommand operation. </summary> <param name="request">Container for the necessary parameters to execute the SendCommand operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.UpdateAssociationStatus(Amazon.SimpleSystemsManagement.Model.UpdateAssociationStatusRequest)"> <summary> Updates the status of the SSM document associated with the specified instance. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAssociationStatus service method.</param> <returns>The response from the UpdateAssociationStatus service method, as returned by SimpleSystemsManagement.</returns> <exception cref="T:Amazon.SimpleSystemsManagement.Model.AssociationDoesNotExistException"> The specified association does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidDocumentException"> The specified document does not exist. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.InvalidInstanceIdException"> The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.StatusUnchangedException"> The updated status is the same as the current status. </exception> <exception cref="T:Amazon.SimpleSystemsManagement.Model.TooManyUpdatesException"> There are concurrent updates for a resource that supports one update at a time. </exception> </member> <member name="M:Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementClient.UpdateAssociationStatusAsync(Amazon.SimpleSystemsManagement.Model.UpdateAssociationStatusRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateAssociationStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAssociationStatus operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient"> <summary> Implementation for accessing SimpleWorkflow Amazon Simple Workflow Service <para> The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a <i>task</i> represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application. </para> <para> Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state. </para> <para> This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/">Amazon SWF Developer Guide</a>. </para> </summary> </member> <member name="T:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow"> <summary> Interface for accessing SimpleWorkflow Amazon Simple Workflow Service <para> The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a <i>task</i> represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application. </para> <para> Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state. </para> <para> This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/">Amazon SWF Developer Guide</a>. </para> </summary> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.CountClosedWorkflowExecutions(Amazon.SimpleWorkflow.Model.CountClosedWorkflowExecutionsRequest)"> <summary> Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria. <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</li> <li><code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</li> <li><code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CountClosedWorkflowExecutions service method.</param> <returns>The response from the CountClosedWorkflowExecutions service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.CountClosedWorkflowExecutionsAsync(Amazon.SimpleWorkflow.Model.CountClosedWorkflowExecutionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CountClosedWorkflowExecutions operation. </summary> <param name="request">Container for the necessary parameters to execute the CountClosedWorkflowExecutions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.CountOpenWorkflowExecutions(Amazon.SimpleWorkflow.Model.CountOpenWorkflowExecutionsRequest)"> <summary> Returns the number of open workflow executions within the given domain that meet the specified filtering criteria. <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</li> <li><code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</li> <li><code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CountOpenWorkflowExecutions service method.</param> <returns>The response from the CountOpenWorkflowExecutions service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.CountOpenWorkflowExecutionsAsync(Amazon.SimpleWorkflow.Model.CountOpenWorkflowExecutionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CountOpenWorkflowExecutions operation. </summary> <param name="request">Container for the necessary parameters to execute the CountOpenWorkflowExecutions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.CountPendingActivityTasks(Amazon.SimpleWorkflow.Model.CountPendingActivityTasksRequest)"> <summary> Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 will be returned. <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the <code>taskList.name</code> parameter by using a <b>Condition</b> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CountPendingActivityTasks service method.</param> <returns>The response from the CountPendingActivityTasks service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.CountPendingActivityTasksAsync(Amazon.SimpleWorkflow.Model.CountPendingActivityTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CountPendingActivityTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the CountPendingActivityTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.CountPendingDecisionTasks(Amazon.SimpleWorkflow.Model.CountPendingDecisionTasksRequest)"> <summary> Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 will be returned. <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the <code>taskList.name</code> parameter by using a <b>Condition</b> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CountPendingDecisionTasks service method.</param> <returns>The response from the CountPendingDecisionTasks service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.CountPendingDecisionTasksAsync(Amazon.SimpleWorkflow.Model.CountPendingDecisionTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CountPendingDecisionTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the CountPendingDecisionTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.DeprecateActivityType(Amazon.SimpleWorkflow.Model.DeprecateActivityTypeRequest)"> <summary> Deprecates the specified <i>activity type</i>. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated will continue to run. <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>activityType.name</code>: String constraint. The key is <code>swf:activityType.name</code>.</li> <li><code>activityType.version</code>: String constraint. The key is <code>swf:activityType.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeprecateActivityType service method.</param> <returns>The response from the DeprecateActivityType service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.TypeDeprecatedException"> Returned when the specified activity or workflow type was already deprecated. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.DeprecateActivityTypeAsync(Amazon.SimpleWorkflow.Model.DeprecateActivityTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeprecateActivityType operation. </summary> <param name="request">Container for the necessary parameters to execute the DeprecateActivityType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.DeprecateDomain(Amazon.SimpleWorkflow.Model.DeprecateDomainRequest)"> <summary> Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run. <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeprecateDomain service method.</param> <returns>The response from the DeprecateDomain service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.DomainDeprecatedException"> Returned when the specified domain has been deprecated. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.DeprecateDomainAsync(Amazon.SimpleWorkflow.Model.DeprecateDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeprecateDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the DeprecateDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.DeprecateWorkflowType(Amazon.SimpleWorkflow.Model.DeprecateWorkflowTypeRequest)"> <summary> Deprecates the specified <i>workflow type</i>. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions. <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>workflowType.name</code>: String constraint. The key is <code>swf:workflowType.name</code>.</li> <li><code>workflowType.version</code>: String constraint. The key is <code>swf:workflowType.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeprecateWorkflowType service method.</param> <returns>The response from the DeprecateWorkflowType service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.TypeDeprecatedException"> Returned when the specified activity or workflow type was already deprecated. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.DeprecateWorkflowTypeAsync(Amazon.SimpleWorkflow.Model.DeprecateWorkflowTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeprecateWorkflowType operation. </summary> <param name="request">Container for the necessary parameters to execute the DeprecateWorkflowType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.DescribeActivityType(Amazon.SimpleWorkflow.Model.DescribeActivityTypeRequest)"> <summary> Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type. <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>activityType.name</code>: String constraint. The key is <code>swf:activityType.name</code>.</li> <li><code>activityType.version</code>: String constraint. The key is <code>swf:activityType.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeActivityType service method.</param> <returns>The response from the DescribeActivityType service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.DescribeActivityTypeAsync(Amazon.SimpleWorkflow.Model.DescribeActivityTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeActivityType operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeActivityType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.DescribeDomain(Amazon.SimpleWorkflow.Model.DescribeDomainRequest)"> <summary> Returns information about the specified domain, including description and status. <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomain service method.</param> <returns>The response from the DescribeDomain service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.DescribeDomainAsync(Amazon.SimpleWorkflow.Model.DescribeDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.DescribeWorkflowExecution(Amazon.SimpleWorkflow.Model.DescribeWorkflowExecutionRequest)"> <summary> Returns information about the specified workflow execution including its type and some statistics. <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkflowExecution service method.</param> <returns>The response from the DescribeWorkflowExecution service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.DescribeWorkflowExecutionAsync(Amazon.SimpleWorkflow.Model.DescribeWorkflowExecutionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeWorkflowExecution operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkflowExecution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.DescribeWorkflowType(Amazon.SimpleWorkflow.Model.DescribeWorkflowTypeRequest)"> <summary> Returns information about the specified <i>workflow type</i>. This includes configuration settings specified when the type was registered and other information such as creation date, current status, and so on. <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>workflowType.name</code>: String constraint. The key is <code>swf:workflowType.name</code>.</li> <li><code>workflowType.version</code>: String constraint. The key is <code>swf:workflowType.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkflowType service method.</param> <returns>The response from the DescribeWorkflowType service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.DescribeWorkflowTypeAsync(Amazon.SimpleWorkflow.Model.DescribeWorkflowTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeWorkflowType operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkflowType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.GetWorkflowExecutionHistory(Amazon.SimpleWorkflow.Model.GetWorkflowExecutionHistoryRequest)"> <summary> Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the <code>nextPageToken</code> returned by the initial call. <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetWorkflowExecutionHistory service method.</param> <returns>The response from the GetWorkflowExecutionHistory service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.GetWorkflowExecutionHistoryAsync(Amazon.SimpleWorkflow.Model.GetWorkflowExecutionHistoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetWorkflowExecutionHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the GetWorkflowExecutionHistory operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.ListActivityTypes(Amazon.SimpleWorkflow.Model.ListActivityTypesRequest)"> <summary> Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the <code>nextPageToken</code> returned by the initial call. <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListActivityTypes service method.</param> <returns>The response from the ListActivityTypes service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.ListActivityTypesAsync(Amazon.SimpleWorkflow.Model.ListActivityTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListActivityTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the ListActivityTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.ListClosedWorkflowExecutions(Amazon.SimpleWorkflow.Model.ListClosedWorkflowExecutionsRequest)"> <summary> Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</li> <li><code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</li> <li><code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListClosedWorkflowExecutions service method.</param> <returns>The response from the ListClosedWorkflowExecutions service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.ListClosedWorkflowExecutionsAsync(Amazon.SimpleWorkflow.Model.ListClosedWorkflowExecutionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListClosedWorkflowExecutions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListClosedWorkflowExecutions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.ListDomains(Amazon.SimpleWorkflow.Model.ListDomainsRequest)"> <summary> Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. <note> This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains. The element must be set to <code>arn:aws:swf::AccountID:domain/*</code>, where <i>AccountID</i> is the account ID, with no dashes.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListDomains service method.</param> <returns>The response from the ListDomains service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.ListDomainsAsync(Amazon.SimpleWorkflow.Model.ListDomainsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDomains operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDomains operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.ListOpenWorkflowExecutions(Amazon.SimpleWorkflow.Model.ListOpenWorkflowExecutionsRequest)"> <summary> Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. <note> This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</li> <li><code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</li> <li><code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListOpenWorkflowExecutions service method.</param> <returns>The response from the ListOpenWorkflowExecutions service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.ListOpenWorkflowExecutionsAsync(Amazon.SimpleWorkflow.Model.ListOpenWorkflowExecutionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListOpenWorkflowExecutions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListOpenWorkflowExecutions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.ListWorkflowTypes(Amazon.SimpleWorkflow.Model.ListWorkflowTypesRequest)"> <summary> Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly. <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListWorkflowTypes service method.</param> <returns>The response from the ListWorkflowTypes service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.ListWorkflowTypesAsync(Amazon.SimpleWorkflow.Model.ListWorkflowTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListWorkflowTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the ListWorkflowTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.PollForActivityTask(Amazon.SimpleWorkflow.Model.PollForActivityTaskRequest)"> <summary> Used by workers to get an <a>ActivityTask</a> from the specified activity <code>taskList</code>. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly. <important>Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).</important> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the <code>taskList.name</code> parameter by using a <b>Condition</b> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PollForActivityTask service method.</param> <returns>The response from the PollForActivityTask service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.LimitExceededException"> Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.PollForActivityTaskAsync(Amazon.SimpleWorkflow.Model.PollForActivityTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PollForActivityTask operation. </summary> <param name="request">Container for the necessary parameters to execute the PollForActivityTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.PollForDecisionTask(Amazon.SimpleWorkflow.Model.PollForDecisionTaskRequest)"> <summary> Used by deciders to get a <a>DecisionTask</a> from the specified decision <code>taskList</code>. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task. <para> This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of <code>taskToken</code> is an empty string. </para> <important>Deciders should set their client-side socket timeout to at least 70 seconds (10 seconds higher than the timeout).</important> <important>Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to <code>PollForDecisionTask</code> using the <code>nextPageToken</code> returned by the initial call. Note that you do <b>not</b> call <code>GetWorkflowExecutionHistory</code> with this <code>nextPageToken</code>. Instead, call <code>PollForDecisionTask</code> again.</important> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the <code>taskList.name</code> parameter by using a <b>Condition</b> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PollForDecisionTask service method.</param> <returns>The response from the PollForDecisionTask service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.LimitExceededException"> Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.PollForDecisionTaskAsync(Amazon.SimpleWorkflow.Model.PollForDecisionTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PollForDecisionTask operation. </summary> <param name="request">Container for the necessary parameters to execute the PollForDecisionTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RecordActivityTaskHeartbeat(Amazon.SimpleWorkflow.Model.RecordActivityTaskHeartbeatRequest)"> <summary> Used by activity workers to report to the service that the <a>ActivityTask</a> represented by the specified <code>taskToken</code> is still making progress. The worker can also (optionally) specify details of the progress, for example percent complete, using the <code>details</code> parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean <code>cancelRequested</code> flag returned by the service is set to <code>true</code>. <para> This action resets the <code>taskHeartbeatTimeout</code> clock. The <code>taskHeartbeatTimeout</code> is specified in <a>RegisterActivityType</a>. </para> <para> This action does not in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history will contain a <code>ActivityTaskTimedOut</code> event that contains the information from the last heartbeat generated by the activity worker. </para> <note>The <code>taskStartToCloseTimeout</code> of an activity type is the maximum duration of an activity task, regardless of the number of <a>RecordActivityTaskHeartbeat</a> requests received. The <code>taskStartToCloseTimeout</code> is also specified in <a>RegisterActivityType</a>.</note> <note>This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted. </note> <important>If the <code>cancelRequested</code> flag returns <code>true</code>, a cancellation is being attempted. If the worker can cancel the activity, it should respond with <a>RespondActivityTaskCanceled</a>. Otherwise, it should ignore the cancellation request.</important> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RecordActivityTaskHeartbeat service method.</param> <returns>The response from the RecordActivityTaskHeartbeat service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RecordActivityTaskHeartbeatAsync(Amazon.SimpleWorkflow.Model.RecordActivityTaskHeartbeatRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RecordActivityTaskHeartbeat operation. </summary> <param name="request">Container for the necessary parameters to execute the RecordActivityTaskHeartbeat operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RegisterActivityType(Amazon.SimpleWorkflow.Model.RegisterActivityTypeRequest)"> <summary> Registers a new <i>activity type</i> along with its configuration settings in the specified domain. <important>A <code>TypeAlreadyExists</code> fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.</important> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li> <code>defaultTaskList.name</code>: String constraint. The key is <code>swf:defaultTaskList.name</code>.</li> <li> <code>name</code>: String constraint. The key is <code>swf:name</code>.</li> <li> <code>version</code>: String constraint. The key is <code>swf:version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterActivityType service method.</param> <returns>The response from the RegisterActivityType service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.LimitExceededException"> Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.TypeAlreadyExistsException"> Returned if the type already exists in the specified domain. You will get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RegisterActivityTypeAsync(Amazon.SimpleWorkflow.Model.RegisterActivityTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterActivityType operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterActivityType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RegisterDomain(Amazon.SimpleWorkflow.Model.RegisterDomainRequest)"> <summary> Registers a new domain. <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterDomain service method.</param> <returns>The response from the RegisterDomain service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.DomainAlreadyExistsException"> Returned if the specified domain already exists. You will get this fault even if the existing domain is in deprecated status. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.LimitExceededException"> Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RegisterDomainAsync(Amazon.SimpleWorkflow.Model.RegisterDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RegisterWorkflowType(Amazon.SimpleWorkflow.Model.RegisterWorkflowTypeRequest)"> <summary> Registers a new <i>workflow type</i> and its configuration settings in the specified domain. <para> The retention period for the workflow history is set by the <a>RegisterDomain</a> action. </para> <important>If the type already exists, then a <code>TypeAlreadyExists</code> fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.</important> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li> <code>defaultTaskList.name</code>: String constraint. The key is <code>swf:defaultTaskList.name</code>.</li> <li> <code>name</code>: String constraint. The key is <code>swf:name</code>.</li> <li> <code>version</code>: String constraint. The key is <code>swf:version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterWorkflowType service method.</param> <returns>The response from the RegisterWorkflowType service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.LimitExceededException"> Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.TypeAlreadyExistsException"> Returned if the type already exists in the specified domain. You will get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RegisterWorkflowTypeAsync(Amazon.SimpleWorkflow.Model.RegisterWorkflowTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterWorkflowType operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterWorkflowType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RequestCancelWorkflowExecution(Amazon.SimpleWorkflow.Model.RequestCancelWorkflowExecutionRequest)"> <summary> Records a <code>WorkflowExecutionCancelRequested</code> event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event. <note>If the runId is not specified, the <code>WorkflowExecutionCancelRequested</code> event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.</note> <note>Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of <a>TerminateWorkflowExecution</a> when possible.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RequestCancelWorkflowExecution service method.</param> <returns>The response from the RequestCancelWorkflowExecution service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RequestCancelWorkflowExecutionAsync(Amazon.SimpleWorkflow.Model.RequestCancelWorkflowExecutionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RequestCancelWorkflowExecution operation. </summary> <param name="request">Container for the necessary parameters to execute the RequestCancelWorkflowExecution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RespondActivityTaskCanceled(Amazon.SimpleWorkflow.Model.RespondActivityTaskCanceledRequest)"> <summary> Used by workers to tell the service that the <a>ActivityTask</a> identified by the <code>taskToken</code> was successfully canceled. Additional <code>details</code> can be optionally provided using the <code>details</code> argument. <para> These <code>details</code> (if provided) appear in the <code>ActivityTaskCanceled</code> event added to the workflow history. </para> <important>Only use this operation if the <code>canceled</code> flag of a <a>RecordActivityTaskHeartbeat</a> request returns <code>true</code> and if the activity can be safely undone or abandoned.</important> <para> A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to <a>RespondActivityTaskCompleted</a>, RespondActivityTaskCanceled, <a>RespondActivityTaskFailed</a>, or the task has <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types">timed out</a>. </para> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RespondActivityTaskCanceled service method.</param> <returns>The response from the RespondActivityTaskCanceled service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RespondActivityTaskCanceledAsync(Amazon.SimpleWorkflow.Model.RespondActivityTaskCanceledRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RespondActivityTaskCanceled operation. </summary> <param name="request">Container for the necessary parameters to execute the RespondActivityTaskCanceled operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RespondActivityTaskCompleted(Amazon.SimpleWorkflow.Model.RespondActivityTaskCompletedRequest)"> <summary> Used by workers to tell the service that the <a>ActivityTask</a> identified by the <code>taskToken</code> completed successfully with a <code>result</code> (if provided). The <code>result</code> appears in the <code>ActivityTaskCompleted</code> event in the workflow history. <important> If the requested task does not complete successfully, use <a>RespondActivityTaskFailed</a> instead. If the worker finds that the task is canceled through the <code>canceled</code> flag returned by <a>RecordActivityTaskHeartbeat</a>, it should cancel the task, clean up and then call <a>RespondActivityTaskCanceled</a>.</important> <para> A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, <a>RespondActivityTaskCanceled</a>, <a>RespondActivityTaskFailed</a>, or the task has <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types">timed out</a>. </para> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RespondActivityTaskCompleted service method.</param> <returns>The response from the RespondActivityTaskCompleted service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RespondActivityTaskCompletedAsync(Amazon.SimpleWorkflow.Model.RespondActivityTaskCompletedRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RespondActivityTaskCompleted operation. </summary> <param name="request">Container for the necessary parameters to execute the RespondActivityTaskCompleted operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RespondActivityTaskFailed(Amazon.SimpleWorkflow.Model.RespondActivityTaskFailedRequest)"> <summary> Used by workers to tell the service that the <a>ActivityTask</a> identified by the <code>taskToken</code> has failed with <code>reason</code> (if specified). The <code>reason</code> and <code>details</code> appear in the <code>ActivityTaskFailed</code> event added to the workflow history. <para> A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to <a>RespondActivityTaskCompleted</a>, <a>RespondActivityTaskCanceled</a>, RespondActivityTaskFailed, or the task has <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types">timed out</a>. </para> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RespondActivityTaskFailed service method.</param> <returns>The response from the RespondActivityTaskFailed service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RespondActivityTaskFailedAsync(Amazon.SimpleWorkflow.Model.RespondActivityTaskFailedRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RespondActivityTaskFailed operation. </summary> <param name="request">Container for the necessary parameters to execute the RespondActivityTaskFailed operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RespondDecisionTaskCompleted(Amazon.SimpleWorkflow.Model.RespondDecisionTaskCompletedRequest)"> <summary> Used by deciders to tell the service that the <a>DecisionTask</a> identified by the <code>taskToken</code> has successfully completed. The <code>decisions</code> argument specifies the list of decisions made while processing the task. <para> A <code>DecisionTaskCompleted</code> event is added to the workflow history. The <code>executionContext</code> specified is attached to the event in the workflow execution history. </para> <para> <b>Access Control</b> </para> <para> If an IAM policy grants permission to use <code>RespondDecisionTaskCompleted</code>, it can express permissions for the list of decisions in the <code>decisions</code> parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RespondDecisionTaskCompleted service method.</param> <returns>The response from the RespondDecisionTaskCompleted service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.RespondDecisionTaskCompletedAsync(Amazon.SimpleWorkflow.Model.RespondDecisionTaskCompletedRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RespondDecisionTaskCompleted operation. </summary> <param name="request">Container for the necessary parameters to execute the RespondDecisionTaskCompleted operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.SignalWorkflowExecution(Amazon.SimpleWorkflow.Model.SignalWorkflowExecutionRequest)"> <summary> Records a <code>WorkflowExecutionSignaled</code> event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided). <note> If a runId is not specified, then the <code>WorkflowExecutionSignaled</code> event is recorded in the history of the current open workflow with the matching workflowId in the domain.</note> <note> If the specified workflow execution is not open, this method fails with <code>UnknownResource</code>.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SignalWorkflowExecution service method.</param> <returns>The response from the SignalWorkflowExecution service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.SignalWorkflowExecutionAsync(Amazon.SimpleWorkflow.Model.SignalWorkflowExecutionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SignalWorkflowExecution operation. </summary> <param name="request">Container for the necessary parameters to execute the SignalWorkflowExecution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.StartWorkflowExecution(Amazon.SimpleWorkflow.Model.StartWorkflowExecutionRequest)"> <summary> Starts an execution of the workflow type in the specified domain using the provided <code>workflowId</code> and input data. <para> This action returns the newly started workflow execution. </para> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li> <code>tagList.member.0</code>: The key is <code>swf:tagList.member.0</code>.</li> <li> <code>tagList.member.1</code>: The key is <code>swf:tagList.member.1</code>.</li> <li> <code>tagList.member.2</code>: The key is <code>swf:tagList.member.2</code>.</li> <li> <code>tagList.member.3</code>: The key is <code>swf:tagList.member.3</code>.</li> <li> <code>tagList.member.4</code>: The key is <code>swf:tagList.member.4</code>.</li> <li><code>taskList</code>: String constraint. The key is <code>swf:taskList.name</code>.</li> <li><code>workflowType.name</code>: String constraint. The key is <code>swf:workflowType.name</code>.</li> <li><code>workflowType.version</code>: String constraint. The key is <code>swf:workflowType.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StartWorkflowExecution service method.</param> <returns>The response from the StartWorkflowExecution service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.DefaultUndefinedException"> </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.LimitExceededException"> Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.TypeDeprecatedException"> Returned when the specified activity or workflow type was already deprecated. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.WorkflowExecutionAlreadyStartedException"> Returned by <a>StartWorkflowExecution</a> when an open execution with the same workflowId is already running in the specified domain. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.StartWorkflowExecutionAsync(Amazon.SimpleWorkflow.Model.StartWorkflowExecutionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartWorkflowExecution operation. </summary> <param name="request">Container for the necessary parameters to execute the StartWorkflowExecution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.TerminateWorkflowExecution(Amazon.SimpleWorkflow.Model.TerminateWorkflowExecutionRequest)"> <summary> Records a <code>WorkflowExecutionTerminated</code> event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution. <important> If the identified workflow execution was in progress, it is terminated immediately.</important> <note> If a runId is not specified, then the <code>WorkflowExecutionTerminated</code> event is recorded in the history of the current open workflow with the matching workflowId in the domain.</note> <note> You should consider using <a>RequestCancelWorkflowExecution</a> action instead because it allows the workflow to gracefully close while <a>TerminateWorkflowExecution</a> does not.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the TerminateWorkflowExecution service method.</param> <returns>The response from the TerminateWorkflowExecution service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.IAmazonSimpleWorkflow.TerminateWorkflowExecutionAsync(Amazon.SimpleWorkflow.Model.TerminateWorkflowExecutionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TerminateWorkflowExecution operation. </summary> <param name="request">Container for the necessary parameters to execute the TerminateWorkflowExecution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.#ctor"> <summary> Constructs AmazonSimpleWorkflowClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleWorkflowClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.#ctor(Amazon.SimpleWorkflow.AmazonSimpleWorkflowConfig)"> <summary> Constructs AmazonSimpleWorkflowClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonSimpleWorkflowClient Configuration Object</param> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonSimpleWorkflowClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleWorkflowClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.SimpleWorkflow.AmazonSimpleWorkflowConfig)"> <summary> Constructs AmazonSimpleWorkflowClient with AWS Credentials and an AmazonSimpleWorkflowClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonSimpleWorkflowClient Configuration Object</param> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonSimpleWorkflowClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleWorkflowClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.#ctor(System.String,System.String,Amazon.SimpleWorkflow.AmazonSimpleWorkflowConfig)"> <summary> Constructs AmazonSimpleWorkflowClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleWorkflowClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonSimpleWorkflowClient Configuration Object</param> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonSimpleWorkflowClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSimpleWorkflowClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.#ctor(System.String,System.String,System.String,Amazon.SimpleWorkflow.AmazonSimpleWorkflowConfig)"> <summary> Constructs AmazonSimpleWorkflowClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleWorkflowClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonSimpleWorkflowClient Configuration Object</param> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.CountClosedWorkflowExecutions(Amazon.SimpleWorkflow.Model.CountClosedWorkflowExecutionsRequest)"> <summary> Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria. <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</li> <li><code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</li> <li><code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CountClosedWorkflowExecutions service method.</param> <returns>The response from the CountClosedWorkflowExecutions service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.CountClosedWorkflowExecutionsAsync(Amazon.SimpleWorkflow.Model.CountClosedWorkflowExecutionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CountClosedWorkflowExecutions operation. </summary> <param name="request">Container for the necessary parameters to execute the CountClosedWorkflowExecutions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.CountOpenWorkflowExecutions(Amazon.SimpleWorkflow.Model.CountOpenWorkflowExecutionsRequest)"> <summary> Returns the number of open workflow executions within the given domain that meet the specified filtering criteria. <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</li> <li><code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</li> <li><code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CountOpenWorkflowExecutions service method.</param> <returns>The response from the CountOpenWorkflowExecutions service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.CountOpenWorkflowExecutionsAsync(Amazon.SimpleWorkflow.Model.CountOpenWorkflowExecutionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CountOpenWorkflowExecutions operation. </summary> <param name="request">Container for the necessary parameters to execute the CountOpenWorkflowExecutions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.CountPendingActivityTasks(Amazon.SimpleWorkflow.Model.CountPendingActivityTasksRequest)"> <summary> Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 will be returned. <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the <code>taskList.name</code> parameter by using a <b>Condition</b> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CountPendingActivityTasks service method.</param> <returns>The response from the CountPendingActivityTasks service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.CountPendingActivityTasksAsync(Amazon.SimpleWorkflow.Model.CountPendingActivityTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CountPendingActivityTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the CountPendingActivityTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.CountPendingDecisionTasks(Amazon.SimpleWorkflow.Model.CountPendingDecisionTasksRequest)"> <summary> Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 will be returned. <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the <code>taskList.name</code> parameter by using a <b>Condition</b> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CountPendingDecisionTasks service method.</param> <returns>The response from the CountPendingDecisionTasks service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.CountPendingDecisionTasksAsync(Amazon.SimpleWorkflow.Model.CountPendingDecisionTasksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CountPendingDecisionTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the CountPendingDecisionTasks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.DeprecateActivityType(Amazon.SimpleWorkflow.Model.DeprecateActivityTypeRequest)"> <summary> Deprecates the specified <i>activity type</i>. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated will continue to run. <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>activityType.name</code>: String constraint. The key is <code>swf:activityType.name</code>.</li> <li><code>activityType.version</code>: String constraint. The key is <code>swf:activityType.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeprecateActivityType service method.</param> <returns>The response from the DeprecateActivityType service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.TypeDeprecatedException"> Returned when the specified activity or workflow type was already deprecated. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.DeprecateActivityTypeAsync(Amazon.SimpleWorkflow.Model.DeprecateActivityTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeprecateActivityType operation. </summary> <param name="request">Container for the necessary parameters to execute the DeprecateActivityType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.DeprecateDomain(Amazon.SimpleWorkflow.Model.DeprecateDomainRequest)"> <summary> Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run. <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeprecateDomain service method.</param> <returns>The response from the DeprecateDomain service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.DomainDeprecatedException"> Returned when the specified domain has been deprecated. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.DeprecateDomainAsync(Amazon.SimpleWorkflow.Model.DeprecateDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeprecateDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the DeprecateDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.DeprecateWorkflowType(Amazon.SimpleWorkflow.Model.DeprecateWorkflowTypeRequest)"> <summary> Deprecates the specified <i>workflow type</i>. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions. <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>workflowType.name</code>: String constraint. The key is <code>swf:workflowType.name</code>.</li> <li><code>workflowType.version</code>: String constraint. The key is <code>swf:workflowType.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeprecateWorkflowType service method.</param> <returns>The response from the DeprecateWorkflowType service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.TypeDeprecatedException"> Returned when the specified activity or workflow type was already deprecated. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.DeprecateWorkflowTypeAsync(Amazon.SimpleWorkflow.Model.DeprecateWorkflowTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeprecateWorkflowType operation. </summary> <param name="request">Container for the necessary parameters to execute the DeprecateWorkflowType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.DescribeActivityType(Amazon.SimpleWorkflow.Model.DescribeActivityTypeRequest)"> <summary> Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type. <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>activityType.name</code>: String constraint. The key is <code>swf:activityType.name</code>.</li> <li><code>activityType.version</code>: String constraint. The key is <code>swf:activityType.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeActivityType service method.</param> <returns>The response from the DescribeActivityType service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.DescribeActivityTypeAsync(Amazon.SimpleWorkflow.Model.DescribeActivityTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeActivityType operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeActivityType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.DescribeDomain(Amazon.SimpleWorkflow.Model.DescribeDomainRequest)"> <summary> Returns information about the specified domain, including description and status. <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomain service method.</param> <returns>The response from the DescribeDomain service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.DescribeDomainAsync(Amazon.SimpleWorkflow.Model.DescribeDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.DescribeWorkflowExecution(Amazon.SimpleWorkflow.Model.DescribeWorkflowExecutionRequest)"> <summary> Returns information about the specified workflow execution including its type and some statistics. <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkflowExecution service method.</param> <returns>The response from the DescribeWorkflowExecution service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.DescribeWorkflowExecutionAsync(Amazon.SimpleWorkflow.Model.DescribeWorkflowExecutionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeWorkflowExecution operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkflowExecution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.DescribeWorkflowType(Amazon.SimpleWorkflow.Model.DescribeWorkflowTypeRequest)"> <summary> Returns information about the specified <i>workflow type</i>. This includes configuration settings specified when the type was registered and other information such as creation date, current status, and so on. <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>workflowType.name</code>: String constraint. The key is <code>swf:workflowType.name</code>.</li> <li><code>workflowType.version</code>: String constraint. The key is <code>swf:workflowType.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkflowType service method.</param> <returns>The response from the DescribeWorkflowType service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.DescribeWorkflowTypeAsync(Amazon.SimpleWorkflow.Model.DescribeWorkflowTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeWorkflowType operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkflowType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.GetWorkflowExecutionHistory(Amazon.SimpleWorkflow.Model.GetWorkflowExecutionHistoryRequest)"> <summary> Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the <code>nextPageToken</code> returned by the initial call. <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetWorkflowExecutionHistory service method.</param> <returns>The response from the GetWorkflowExecutionHistory service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.GetWorkflowExecutionHistoryAsync(Amazon.SimpleWorkflow.Model.GetWorkflowExecutionHistoryRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetWorkflowExecutionHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the GetWorkflowExecutionHistory operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.ListActivityTypes(Amazon.SimpleWorkflow.Model.ListActivityTypesRequest)"> <summary> Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the <code>nextPageToken</code> returned by the initial call. <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListActivityTypes service method.</param> <returns>The response from the ListActivityTypes service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.ListActivityTypesAsync(Amazon.SimpleWorkflow.Model.ListActivityTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListActivityTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the ListActivityTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.ListClosedWorkflowExecutions(Amazon.SimpleWorkflow.Model.ListClosedWorkflowExecutionsRequest)"> <summary> Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. <note>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</li> <li><code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</li> <li><code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListClosedWorkflowExecutions service method.</param> <returns>The response from the ListClosedWorkflowExecutions service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.ListClosedWorkflowExecutionsAsync(Amazon.SimpleWorkflow.Model.ListClosedWorkflowExecutionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListClosedWorkflowExecutions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListClosedWorkflowExecutions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.ListDomains(Amazon.SimpleWorkflow.Model.ListDomainsRequest)"> <summary> Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. <note> This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains. The element must be set to <code>arn:aws:swf::AccountID:domain/*</code>, where <i>AccountID</i> is the account ID, with no dashes.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListDomains service method.</param> <returns>The response from the ListDomains service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.ListDomainsAsync(Amazon.SimpleWorkflow.Model.ListDomainsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDomains operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDomains operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.ListOpenWorkflowExecutions(Amazon.SimpleWorkflow.Model.ListOpenWorkflowExecutionsRequest)"> <summary> Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. <note> This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li><code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</li> <li><code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</li> <li><code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListOpenWorkflowExecutions service method.</param> <returns>The response from the ListOpenWorkflowExecutions service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.ListOpenWorkflowExecutionsAsync(Amazon.SimpleWorkflow.Model.ListOpenWorkflowExecutionsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListOpenWorkflowExecutions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListOpenWorkflowExecutions operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.ListWorkflowTypes(Amazon.SimpleWorkflow.Model.ListWorkflowTypesRequest)"> <summary> Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly. <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListWorkflowTypes service method.</param> <returns>The response from the ListWorkflowTypes service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.ListWorkflowTypesAsync(Amazon.SimpleWorkflow.Model.ListWorkflowTypesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListWorkflowTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the ListWorkflowTypes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.PollForActivityTask(Amazon.SimpleWorkflow.Model.PollForActivityTaskRequest)"> <summary> Used by workers to get an <a>ActivityTask</a> from the specified activity <code>taskList</code>. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly. <important>Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).</important> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the <code>taskList.name</code> parameter by using a <b>Condition</b> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PollForActivityTask service method.</param> <returns>The response from the PollForActivityTask service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.LimitExceededException"> Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.PollForActivityTaskAsync(Amazon.SimpleWorkflow.Model.PollForActivityTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PollForActivityTask operation. </summary> <param name="request">Container for the necessary parameters to execute the PollForActivityTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.PollForDecisionTask(Amazon.SimpleWorkflow.Model.PollForDecisionTaskRequest)"> <summary> Used by deciders to get a <a>DecisionTask</a> from the specified decision <code>taskList</code>. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task. <para> This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of <code>taskToken</code> is an empty string. </para> <important>Deciders should set their client-side socket timeout to at least 70 seconds (10 seconds higher than the timeout).</important> <important>Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to <code>PollForDecisionTask</code> using the <code>nextPageToken</code> returned by the initial call. Note that you do <b>not</b> call <code>GetWorkflowExecutionHistory</code> with this <code>nextPageToken</code>. Instead, call <code>PollForDecisionTask</code> again.</important> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the <code>taskList.name</code> parameter by using a <b>Condition</b> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PollForDecisionTask service method.</param> <returns>The response from the PollForDecisionTask service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.LimitExceededException"> Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.PollForDecisionTaskAsync(Amazon.SimpleWorkflow.Model.PollForDecisionTaskRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PollForDecisionTask operation. </summary> <param name="request">Container for the necessary parameters to execute the PollForDecisionTask operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RecordActivityTaskHeartbeat(Amazon.SimpleWorkflow.Model.RecordActivityTaskHeartbeatRequest)"> <summary> Used by activity workers to report to the service that the <a>ActivityTask</a> represented by the specified <code>taskToken</code> is still making progress. The worker can also (optionally) specify details of the progress, for example percent complete, using the <code>details</code> parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean <code>cancelRequested</code> flag returned by the service is set to <code>true</code>. <para> This action resets the <code>taskHeartbeatTimeout</code> clock. The <code>taskHeartbeatTimeout</code> is specified in <a>RegisterActivityType</a>. </para> <para> This action does not in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history will contain a <code>ActivityTaskTimedOut</code> event that contains the information from the last heartbeat generated by the activity worker. </para> <note>The <code>taskStartToCloseTimeout</code> of an activity type is the maximum duration of an activity task, regardless of the number of <a>RecordActivityTaskHeartbeat</a> requests received. The <code>taskStartToCloseTimeout</code> is also specified in <a>RegisterActivityType</a>.</note> <note>This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted. </note> <important>If the <code>cancelRequested</code> flag returns <code>true</code>, a cancellation is being attempted. If the worker can cancel the activity, it should respond with <a>RespondActivityTaskCanceled</a>. Otherwise, it should ignore the cancellation request.</important> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RecordActivityTaskHeartbeat service method.</param> <returns>The response from the RecordActivityTaskHeartbeat service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RecordActivityTaskHeartbeatAsync(Amazon.SimpleWorkflow.Model.RecordActivityTaskHeartbeatRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RecordActivityTaskHeartbeat operation. </summary> <param name="request">Container for the necessary parameters to execute the RecordActivityTaskHeartbeat operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RegisterActivityType(Amazon.SimpleWorkflow.Model.RegisterActivityTypeRequest)"> <summary> Registers a new <i>activity type</i> along with its configuration settings in the specified domain. <important>A <code>TypeAlreadyExists</code> fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.</important> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li> <code>defaultTaskList.name</code>: String constraint. The key is <code>swf:defaultTaskList.name</code>.</li> <li> <code>name</code>: String constraint. The key is <code>swf:name</code>.</li> <li> <code>version</code>: String constraint. The key is <code>swf:version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterActivityType service method.</param> <returns>The response from the RegisterActivityType service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.LimitExceededException"> Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.TypeAlreadyExistsException"> Returned if the type already exists in the specified domain. You will get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RegisterActivityTypeAsync(Amazon.SimpleWorkflow.Model.RegisterActivityTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterActivityType operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterActivityType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RegisterDomain(Amazon.SimpleWorkflow.Model.RegisterDomainRequest)"> <summary> Registers a new domain. <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterDomain service method.</param> <returns>The response from the RegisterDomain service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.DomainAlreadyExistsException"> Returned if the specified domain already exists. You will get this fault even if the existing domain is in deprecated status. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.LimitExceededException"> Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RegisterDomainAsync(Amazon.SimpleWorkflow.Model.RegisterDomainRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterDomain operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RegisterWorkflowType(Amazon.SimpleWorkflow.Model.RegisterWorkflowTypeRequest)"> <summary> Registers a new <i>workflow type</i> and its configuration settings in the specified domain. <para> The retention period for the workflow history is set by the <a>RegisterDomain</a> action. </para> <important>If the type already exists, then a <code>TypeAlreadyExists</code> fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.</important> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li> <code>defaultTaskList.name</code>: String constraint. The key is <code>swf:defaultTaskList.name</code>.</li> <li> <code>name</code>: String constraint. The key is <code>swf:name</code>.</li> <li> <code>version</code>: String constraint. The key is <code>swf:version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterWorkflowType service method.</param> <returns>The response from the RegisterWorkflowType service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.LimitExceededException"> Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.TypeAlreadyExistsException"> Returned if the type already exists in the specified domain. You will get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RegisterWorkflowTypeAsync(Amazon.SimpleWorkflow.Model.RegisterWorkflowTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RegisterWorkflowType operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterWorkflowType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RequestCancelWorkflowExecution(Amazon.SimpleWorkflow.Model.RequestCancelWorkflowExecutionRequest)"> <summary> Records a <code>WorkflowExecutionCancelRequested</code> event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event. <note>If the runId is not specified, the <code>WorkflowExecutionCancelRequested</code> event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.</note> <note>Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of <a>TerminateWorkflowExecution</a> when possible.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RequestCancelWorkflowExecution service method.</param> <returns>The response from the RequestCancelWorkflowExecution service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RequestCancelWorkflowExecutionAsync(Amazon.SimpleWorkflow.Model.RequestCancelWorkflowExecutionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RequestCancelWorkflowExecution operation. </summary> <param name="request">Container for the necessary parameters to execute the RequestCancelWorkflowExecution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RespondActivityTaskCanceled(Amazon.SimpleWorkflow.Model.RespondActivityTaskCanceledRequest)"> <summary> Used by workers to tell the service that the <a>ActivityTask</a> identified by the <code>taskToken</code> was successfully canceled. Additional <code>details</code> can be optionally provided using the <code>details</code> argument. <para> These <code>details</code> (if provided) appear in the <code>ActivityTaskCanceled</code> event added to the workflow history. </para> <important>Only use this operation if the <code>canceled</code> flag of a <a>RecordActivityTaskHeartbeat</a> request returns <code>true</code> and if the activity can be safely undone or abandoned.</important> <para> A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to <a>RespondActivityTaskCompleted</a>, RespondActivityTaskCanceled, <a>RespondActivityTaskFailed</a>, or the task has <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types">timed out</a>. </para> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RespondActivityTaskCanceled service method.</param> <returns>The response from the RespondActivityTaskCanceled service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RespondActivityTaskCanceledAsync(Amazon.SimpleWorkflow.Model.RespondActivityTaskCanceledRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RespondActivityTaskCanceled operation. </summary> <param name="request">Container for the necessary parameters to execute the RespondActivityTaskCanceled operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RespondActivityTaskCompleted(Amazon.SimpleWorkflow.Model.RespondActivityTaskCompletedRequest)"> <summary> Used by workers to tell the service that the <a>ActivityTask</a> identified by the <code>taskToken</code> completed successfully with a <code>result</code> (if provided). The <code>result</code> appears in the <code>ActivityTaskCompleted</code> event in the workflow history. <important> If the requested task does not complete successfully, use <a>RespondActivityTaskFailed</a> instead. If the worker finds that the task is canceled through the <code>canceled</code> flag returned by <a>RecordActivityTaskHeartbeat</a>, it should cancel the task, clean up and then call <a>RespondActivityTaskCanceled</a>.</important> <para> A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, <a>RespondActivityTaskCanceled</a>, <a>RespondActivityTaskFailed</a>, or the task has <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types">timed out</a>. </para> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RespondActivityTaskCompleted service method.</param> <returns>The response from the RespondActivityTaskCompleted service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RespondActivityTaskCompletedAsync(Amazon.SimpleWorkflow.Model.RespondActivityTaskCompletedRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RespondActivityTaskCompleted operation. </summary> <param name="request">Container for the necessary parameters to execute the RespondActivityTaskCompleted operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RespondActivityTaskFailed(Amazon.SimpleWorkflow.Model.RespondActivityTaskFailedRequest)"> <summary> Used by workers to tell the service that the <a>ActivityTask</a> identified by the <code>taskToken</code> has failed with <code>reason</code> (if specified). The <code>reason</code> and <code>details</code> appear in the <code>ActivityTaskFailed</code> event added to the workflow history. <para> A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to <a>RespondActivityTaskCompleted</a>, <a>RespondActivityTaskCanceled</a>, RespondActivityTaskFailed, or the task has <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types">timed out</a>. </para> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RespondActivityTaskFailed service method.</param> <returns>The response from the RespondActivityTaskFailed service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RespondActivityTaskFailedAsync(Amazon.SimpleWorkflow.Model.RespondActivityTaskFailedRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RespondActivityTaskFailed operation. </summary> <param name="request">Container for the necessary parameters to execute the RespondActivityTaskFailed operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RespondDecisionTaskCompleted(Amazon.SimpleWorkflow.Model.RespondDecisionTaskCompletedRequest)"> <summary> Used by deciders to tell the service that the <a>DecisionTask</a> identified by the <code>taskToken</code> has successfully completed. The <code>decisions</code> argument specifies the list of decisions made while processing the task. <para> A <code>DecisionTaskCompleted</code> event is added to the workflow history. The <code>executionContext</code> specified is attached to the event in the workflow execution history. </para> <para> <b>Access Control</b> </para> <para> If an IAM policy grants permission to use <code>RespondDecisionTaskCompleted</code>, it can express permissions for the list of decisions in the <code>decisions</code> parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RespondDecisionTaskCompleted service method.</param> <returns>The response from the RespondDecisionTaskCompleted service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.RespondDecisionTaskCompletedAsync(Amazon.SimpleWorkflow.Model.RespondDecisionTaskCompletedRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RespondDecisionTaskCompleted operation. </summary> <param name="request">Container for the necessary parameters to execute the RespondDecisionTaskCompleted operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.SignalWorkflowExecution(Amazon.SimpleWorkflow.Model.SignalWorkflowExecutionRequest)"> <summary> Records a <code>WorkflowExecutionSignaled</code> event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided). <note> If a runId is not specified, then the <code>WorkflowExecutionSignaled</code> event is recorded in the history of the current open workflow with the matching workflowId in the domain.</note> <note> If the specified workflow execution is not open, this method fails with <code>UnknownResource</code>.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SignalWorkflowExecution service method.</param> <returns>The response from the SignalWorkflowExecution service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.SignalWorkflowExecutionAsync(Amazon.SimpleWorkflow.Model.SignalWorkflowExecutionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SignalWorkflowExecution operation. </summary> <param name="request">Container for the necessary parameters to execute the SignalWorkflowExecution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.StartWorkflowExecution(Amazon.SimpleWorkflow.Model.StartWorkflowExecutionRequest)"> <summary> Starts an execution of the workflow type in the specified domain using the provided <code>workflowId</code> and input data. <para> This action returns the newly started workflow execution. </para> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys. <ul> <li> <code>tagList.member.0</code>: The key is <code>swf:tagList.member.0</code>.</li> <li> <code>tagList.member.1</code>: The key is <code>swf:tagList.member.1</code>.</li> <li> <code>tagList.member.2</code>: The key is <code>swf:tagList.member.2</code>.</li> <li> <code>tagList.member.3</code>: The key is <code>swf:tagList.member.3</code>.</li> <li> <code>tagList.member.4</code>: The key is <code>swf:tagList.member.4</code>.</li> <li><code>taskList</code>: String constraint. The key is <code>swf:taskList.name</code>.</li> <li><code>workflowType.name</code>: String constraint. The key is <code>swf:workflowType.name</code>.</li> <li><code>workflowType.version</code>: String constraint. The key is <code>swf:workflowType.version</code>.</li> </ul> </li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StartWorkflowExecution service method.</param> <returns>The response from the StartWorkflowExecution service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.DefaultUndefinedException"> </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.LimitExceededException"> Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.TypeDeprecatedException"> Returned when the specified activity or workflow type was already deprecated. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.WorkflowExecutionAlreadyStartedException"> Returned by <a>StartWorkflowExecution</a> when an open execution with the same workflowId is already running in the specified domain. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.StartWorkflowExecutionAsync(Amazon.SimpleWorkflow.Model.StartWorkflowExecutionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartWorkflowExecution operation. </summary> <param name="request">Container for the necessary parameters to execute the StartWorkflowExecution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.TerminateWorkflowExecution(Amazon.SimpleWorkflow.Model.TerminateWorkflowExecutionRequest)"> <summary> Records a <code>WorkflowExecutionTerminated</code> event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution. <important> If the identified workflow execution was in progress, it is terminated immediately.</important> <note> If a runId is not specified, then the <code>WorkflowExecutionTerminated</code> event is recorded in the history of the current open workflow with the matching workflowId in the domain.</note> <note> You should consider using <a>RequestCancelWorkflowExecution</a> action instead because it allows the workflow to gracefully close while <a>TerminateWorkflowExecution</a> does not.</note> <para> <b>Access Control</b> </para> <para> You can use IAM policies to control this action's access to Amazon SWF resources as follows: </para> <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li> <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain this action's parameters.</li> </ul> <para> If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the TerminateWorkflowExecution service method.</param> <returns>The response from the TerminateWorkflowExecution service method, as returned by SimpleWorkflow.</returns> <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException"> Returned when the caller does not have sufficient permissions to invoke the action. </exception> <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException"> Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. </exception> </member> <member name="M:Amazon.SimpleWorkflow.AmazonSimpleWorkflowClient.TerminateWorkflowExecutionAsync(Amazon.SimpleWorkflow.Model.TerminateWorkflowExecutionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TerminateWorkflowExecution operation. </summary> <param name="request">Container for the necessary parameters to execute the TerminateWorkflowExecution operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.SQS.AmazonSQSClient"> <summary> Implementation for accessing SQS Welcome to the <i>Amazon Simple Queue Service API Reference</i>. This section describes who should read this guide, how the guide is organized, and other resources related to the Amazon Simple Queue Service (Amazon SQS). <para> Amazon SQS offers reliable and scalable hosted queues for storing messages as they travel between computers. By using Amazon SQS, you can move data between distributed components of your applications that perform different tasks without losing messages or requiring each component to be always available. </para> <para> Helpful Links: <ul> <li><a href="http://queue.amazonaws.com/doc/2012-11-05/QueueService.wsdl">Current WSDL (2012-11-05)</a></li> <li><a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/MakingRequestsArticle.html">Making API Requests</a></li> <li><a href="http://aws.amazon.com/sqs/">Amazon SQS product page</a></li> <li><a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSMessageAttributes.html">Using Amazon SQS Message Attributes</a></li> <li><a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html">Using Amazon SQS Dead Letter Queues</a></li> <li><a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region">Regions and Endpoints</a></li> </ul> </para> <para> We also provide SDKs that enable you to access Amazon SQS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: </para> <para> <ul> <li>Cryptographically signing your service requests</li> <li>Retrying requests</li> <li>Handling error responses</li> </ul> </para> <para> For a list of available SDKs, go to <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>. </para> </summary> </member> <member name="T:Amazon.SQS.IAmazonSQS"> <summary> Interface for accessing SQS Welcome to the <i>Amazon Simple Queue Service API Reference</i>. This section describes who should read this guide, how the guide is organized, and other resources related to the Amazon Simple Queue Service (Amazon SQS). <para> Amazon SQS offers reliable and scalable hosted queues for storing messages as they travel between computers. By using Amazon SQS, you can move data between distributed components of your applications that perform different tasks without losing messages or requiring each component to be always available. </para> <para> Helpful Links: <ul> <li><a href="http://queue.amazonaws.com/doc/2012-11-05/QueueService.wsdl">Current WSDL (2012-11-05)</a></li> <li><a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/MakingRequestsArticle.html">Making API Requests</a></li> <li><a href="http://aws.amazon.com/sqs/">Amazon SQS product page</a></li> <li><a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSMessageAttributes.html">Using Amazon SQS Message Attributes</a></li> <li><a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html">Using Amazon SQS Dead Letter Queues</a></li> <li><a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region">Regions and Endpoints</a></li> </ul> </para> <para> We also provide SDKs that enable you to access Amazon SQS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: </para> <para> <ul> <li>Cryptographically signing your service requests</li> <li>Retrying requests</li> <li>Handling error responses</li> </ul> </para> <para> For a list of available SDKs, go to <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>. </para> </summary> </member> <member name="M:Amazon.SQS.IAmazonSQS.AddPermission(System.String,System.String,System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String})"> <summary> Adds a permission to a queue for a specific <a href="http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principal</a>. This allows for sharing access to the queue. <para> When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html">Shared Queues</a> in the <i>Amazon SQS Developer Guide</i>. </para> <note> <para> <code>AddPermission</code> writes an Amazon SQS-generated policy. If you want to write your own policy, use <a>SetQueueAttributes</a> to upload your policy. For more information about writing your own policy, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AccessPolicyLanguage.html">Using The Access Policy Language</a> in the <i>Amazon SQS Developer Guide</i>. </para> </note> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="label">The unique identification of the permission you're setting (e.g., <code>AliceSendMessage</code>). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.</param> <param name="awsAccountIds">The AWS account number of the <a href="http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principal</a> who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AWSCredentials.html">Your AWS Identifiers</a> in the <i>Amazon SQS Developer Guide</i>.</param> <param name="actions">The action the client wants to allow for the specified principal. The following are valid values: <code>* | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl</code>. For more information about these actions, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html#PermissionTypes">Understanding Permissions</a> in the <i>Amazon SQS Developer Guide</i>. Specifying <code>SendMessage</code>, <code>DeleteMessage</code>, or <code>ChangeMessageVisibility</code> for the <code>ActionName.n</code> also grants permissions for the corresponding batch versions of those actions: <code>SendMessageBatch</code>, <code>DeleteMessageBatch</code>, and <code>ChangeMessageVisibilityBatch</code>.</param> <returns>The response from the AddPermission service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.OverLimitException"> The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of messages inflight has already been reached. <a>AddPermission</a> returns this error if the maximum number of permissions for the queue has already been reached. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.AddPermission(Amazon.SQS.Model.AddPermissionRequest)"> <summary> Adds a permission to a queue for a specific <a href="http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principal</a>. This allows for sharing access to the queue. <para> When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html">Shared Queues</a> in the <i>Amazon SQS Developer Guide</i>. </para> <note> <para> <code>AddPermission</code> writes an Amazon SQS-generated policy. If you want to write your own policy, use <a>SetQueueAttributes</a> to upload your policy. For more information about writing your own policy, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AccessPolicyLanguage.html">Using The Access Policy Language</a> in the <i>Amazon SQS Developer Guide</i>. </para> </note> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="request">Container for the necessary parameters to execute the AddPermission service method.</param> <returns>The response from the AddPermission service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.OverLimitException"> The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of messages inflight has already been reached. <a>AddPermission</a> returns this error if the maximum number of permissions for the queue has already been reached. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.AddPermissionAsync(Amazon.SQS.Model.AddPermissionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddPermission operation. </summary> <param name="request">Container for the necessary parameters to execute the AddPermission operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.ChangeMessageVisibility(System.String,System.String,System.Int32)"> <summary> Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.) <para> For example, let's say you have a message and its default message visibility timeout is 30 minutes. You could call <code>ChangeMessageVisiblity</code> with a value of two hours and the effective timeout would be two hours and 30 minutes. When that time comes near you could again extend the time out by calling ChangeMessageVisiblity, but this time the maximum allowed timeout would be 9 hours and 30 minutes. </para> <note> <para> There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages. </para> </note> <important>If you attempt to set the <code>VisibilityTimeout</code> to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.</important> <important>Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the <code>ChangeMessageVisibility</code> action.</important> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="receiptHandle">The receipt handle associated with the message whose visibility timeout should be changed. This parameter is returned by the <a>ReceiveMessage</a> action.</param> <param name="visibilityTimeout">The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.</param> <returns>The response from the ChangeMessageVisibility service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.MessageNotInflightException"> The message referred to is not in flight. </exception> <exception cref="T:Amazon.SQS.Model.ReceiptHandleIsInvalidException"> The receipt handle provided is not valid. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.ChangeMessageVisibility(Amazon.SQS.Model.ChangeMessageVisibilityRequest)"> <summary> Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.) <para> For example, let's say you have a message and its default message visibility timeout is 30 minutes. You could call <code>ChangeMessageVisiblity</code> with a value of two hours and the effective timeout would be two hours and 30 minutes. When that time comes near you could again extend the time out by calling ChangeMessageVisiblity, but this time the maximum allowed timeout would be 9 hours and 30 minutes. </para> <note> <para> There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages. </para> </note> <important>If you attempt to set the <code>VisibilityTimeout</code> to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.</important> <important>Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the <code>ChangeMessageVisibility</code> action.</important> </summary> <param name="request">Container for the necessary parameters to execute the ChangeMessageVisibility service method.</param> <returns>The response from the ChangeMessageVisibility service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.MessageNotInflightException"> The message referred to is not in flight. </exception> <exception cref="T:Amazon.SQS.Model.ReceiptHandleIsInvalidException"> The receipt handle provided is not valid. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.ChangeMessageVisibilityAsync(Amazon.SQS.Model.ChangeMessageVisibilityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ChangeMessageVisibility operation. </summary> <param name="request">Container for the necessary parameters to execute the ChangeMessageVisibility operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.ChangeMessageVisibilityBatch(System.String,System.Collections.Generic.List{Amazon.SQS.Model.ChangeMessageVisibilityBatchRequestEntry})"> <summary> Changes the visibility timeout of multiple messages. This is a batch version of <a>ChangeMessageVisibility</a>. The result of the action on each message is reported individually in the response. You can send up to 10 <a>ChangeMessageVisibility</a> requests with each <code>ChangeMessageVisibilityBatch</code> action. <important>Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.</important> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="entries">A list of receipt handles of the messages for which the visibility timeout must be changed.</param> <returns>The response from the ChangeMessageVisibilityBatch service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.BatchEntryIdsNotDistinctException"> Two or more batch entries have the same <code>Id</code> in the request. </exception> <exception cref="T:Amazon.SQS.Model.EmptyBatchRequestException"> Batch request does not contain an entry. </exception> <exception cref="T:Amazon.SQS.Model.InvalidBatchEntryIdException"> The <code>Id</code> of a batch entry in a batch request does not abide by the specification. </exception> <exception cref="T:Amazon.SQS.Model.TooManyEntriesInBatchRequestException"> Batch request contains more number of entries than permissible. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.ChangeMessageVisibilityBatch(Amazon.SQS.Model.ChangeMessageVisibilityBatchRequest)"> <summary> Changes the visibility timeout of multiple messages. This is a batch version of <a>ChangeMessageVisibility</a>. The result of the action on each message is reported individually in the response. You can send up to 10 <a>ChangeMessageVisibility</a> requests with each <code>ChangeMessageVisibilityBatch</code> action. <important>Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.</important> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="request">Container for the necessary parameters to execute the ChangeMessageVisibilityBatch service method.</param> <returns>The response from the ChangeMessageVisibilityBatch service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.BatchEntryIdsNotDistinctException"> Two or more batch entries have the same <code>Id</code> in the request. </exception> <exception cref="T:Amazon.SQS.Model.EmptyBatchRequestException"> Batch request does not contain an entry. </exception> <exception cref="T:Amazon.SQS.Model.InvalidBatchEntryIdException"> The <code>Id</code> of a batch entry in a batch request does not abide by the specification. </exception> <exception cref="T:Amazon.SQS.Model.TooManyEntriesInBatchRequestException"> Batch request contains more number of entries than permissible. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.ChangeMessageVisibilityBatchAsync(Amazon.SQS.Model.ChangeMessageVisibilityBatchRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ChangeMessageVisibilityBatch operation. </summary> <param name="request">Container for the necessary parameters to execute the ChangeMessageVisibilityBatch operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.CreateQueue(System.String)"> <summary> Creates a new queue, or returns the URL of an existing one. When you request <code>CreateQueue</code>, you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues. <note> <para> If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. </para> </note> <para> You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute. Permitted attributes are the same that can be set using <a>SetQueueAttributes</a>. </para> <note> <para> Use <a>GetQueueUrl</a> to get a queue's URL. <a>GetQueueUrl</a> requires only the <code>QueueName</code> parameter. </para> </note> <para> If you provide the name of an existing queue, along with the exact names and values of all the queue's attributes, <code>CreateQueue</code> returns the queue URL for the existing queue. If the queue name, attribute names, or attribute values do not match an existing queue, <code>CreateQueue</code> returns an error. </para> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="queueName">The name for the queue to be created.</param> <returns>The response from the CreateQueue service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.QueueDeletedRecentlyException"> You must wait 60 seconds after deleting a queue before you can create another with the same name. </exception> <exception cref="T:Amazon.SQS.Model.QueueNameExistsException"> A queue already exists with this name. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.CreateQueue(Amazon.SQS.Model.CreateQueueRequest)"> <summary> Creates a new queue, or returns the URL of an existing one. When you request <code>CreateQueue</code>, you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues. <note> <para> If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. </para> </note> <para> You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute. Permitted attributes are the same that can be set using <a>SetQueueAttributes</a>. </para> <note> <para> Use <a>GetQueueUrl</a> to get a queue's URL. <a>GetQueueUrl</a> requires only the <code>QueueName</code> parameter. </para> </note> <para> If you provide the name of an existing queue, along with the exact names and values of all the queue's attributes, <code>CreateQueue</code> returns the queue URL for the existing queue. If the queue name, attribute names, or attribute values do not match an existing queue, <code>CreateQueue</code> returns an error. </para> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateQueue service method.</param> <returns>The response from the CreateQueue service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.QueueDeletedRecentlyException"> You must wait 60 seconds after deleting a queue before you can create another with the same name. </exception> <exception cref="T:Amazon.SQS.Model.QueueNameExistsException"> A queue already exists with this name. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.CreateQueueAsync(Amazon.SQS.Model.CreateQueueRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateQueue operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateQueue operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.DeleteMessage(System.String,System.String)"> <summary> Deletes the specified message from the specified queue. You specify the message by using the message's <code>receipt handle</code> and not the <code>message ID</code> you received when you sent the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes it. <note> <para> The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. When you request <code>DeleteMessage</code>, if you don't provide the most recently received receipt handle for the message, the request will still succeed, but the message might not be deleted. </para> </note> <important> <para> It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem. </para> </important> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="receiptHandle">The receipt handle associated with the message to delete.</param> <returns>The response from the DeleteMessage service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.InvalidIdFormatException"> The receipt handle is not valid for the current version. </exception> <exception cref="T:Amazon.SQS.Model.ReceiptHandleIsInvalidException"> The receipt handle provided is not valid. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.DeleteMessage(Amazon.SQS.Model.DeleteMessageRequest)"> <summary> Deletes the specified message from the specified queue. You specify the message by using the message's <code>receipt handle</code> and not the <code>message ID</code> you received when you sent the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes it. <note> <para> The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. When you request <code>DeleteMessage</code>, if you don't provide the most recently received receipt handle for the message, the request will still succeed, but the message might not be deleted. </para> </note> <important> <para> It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteMessage service method.</param> <returns>The response from the DeleteMessage service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.InvalidIdFormatException"> The receipt handle is not valid for the current version. </exception> <exception cref="T:Amazon.SQS.Model.ReceiptHandleIsInvalidException"> The receipt handle provided is not valid. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.DeleteMessageAsync(Amazon.SQS.Model.DeleteMessageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteMessage operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteMessage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.DeleteMessageBatch(System.String,System.Collections.Generic.List{Amazon.SQS.Model.DeleteMessageBatchRequestEntry})"> <summary> Deletes up to ten messages from the specified queue. This is a batch version of <a>DeleteMessage</a>. The result of the delete action on each message is reported individually in the response. <important> <para> Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. </para> </important> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="entries">A list of receipt handles for the messages to be deleted.</param> <returns>The response from the DeleteMessageBatch service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.BatchEntryIdsNotDistinctException"> Two or more batch entries have the same <code>Id</code> in the request. </exception> <exception cref="T:Amazon.SQS.Model.EmptyBatchRequestException"> Batch request does not contain an entry. </exception> <exception cref="T:Amazon.SQS.Model.InvalidBatchEntryIdException"> The <code>Id</code> of a batch entry in a batch request does not abide by the specification. </exception> <exception cref="T:Amazon.SQS.Model.TooManyEntriesInBatchRequestException"> Batch request contains more number of entries than permissible. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.DeleteMessageBatch(Amazon.SQS.Model.DeleteMessageBatchRequest)"> <summary> Deletes up to ten messages from the specified queue. This is a batch version of <a>DeleteMessage</a>. The result of the delete action on each message is reported individually in the response. <important> <para> Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. </para> </important> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteMessageBatch service method.</param> <returns>The response from the DeleteMessageBatch service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.BatchEntryIdsNotDistinctException"> Two or more batch entries have the same <code>Id</code> in the request. </exception> <exception cref="T:Amazon.SQS.Model.EmptyBatchRequestException"> Batch request does not contain an entry. </exception> <exception cref="T:Amazon.SQS.Model.InvalidBatchEntryIdException"> The <code>Id</code> of a batch entry in a batch request does not abide by the specification. </exception> <exception cref="T:Amazon.SQS.Model.TooManyEntriesInBatchRequestException"> Batch request contains more number of entries than permissible. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.DeleteMessageBatchAsync(Amazon.SQS.Model.DeleteMessageBatchRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteMessageBatch operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteMessageBatch operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.DeleteQueue(System.String)"> <summary> Deletes the queue specified by the <b>queue URL</b>, regardless of whether the queue is empty. If the specified queue does not exist, Amazon SQS returns a successful response. <important> <para> Use <code>DeleteQueue</code> with care; once you delete your queue, any messages in the queue are no longer available. </para> </important> <para> When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a <a>SendMessage</a> request might succeed, but after the 60 seconds, the queue and that message you sent no longer exist. Also, when you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. </para> <para> We reserve the right to delete queues that have had no activity for more than 30 days. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSConcepts.html">How Amazon SQS Queues Work</a> in the <i>Amazon SQS Developer Guide</i>. </para> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <returns>The response from the DeleteQueue service method, as returned by SQS.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.DeleteQueue(Amazon.SQS.Model.DeleteQueueRequest)"> <summary> Deletes the queue specified by the <b>queue URL</b>, regardless of whether the queue is empty. If the specified queue does not exist, Amazon SQS returns a successful response. <important> <para> Use <code>DeleteQueue</code> with care; once you delete your queue, any messages in the queue are no longer available. </para> </important> <para> When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a <a>SendMessage</a> request might succeed, but after the 60 seconds, the queue and that message you sent no longer exist. Also, when you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. </para> <para> We reserve the right to delete queues that have had no activity for more than 30 days. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSConcepts.html">How Amazon SQS Queues Work</a> in the <i>Amazon SQS Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteQueue service method.</param> <returns>The response from the DeleteQueue service method, as returned by SQS.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.DeleteQueueAsync(Amazon.SQS.Model.DeleteQueueRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteQueue operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteQueue operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.GetQueueAttributes(System.String,System.Collections.Generic.List{System.String})"> <summary> Gets attributes for the specified queue. The following attributes are supported: <ul> <li> <code>All</code> - returns all values.</li> <li> <code>ApproximateNumberOfMessages</code> - returns the approximate number of visible messages in a queue. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html">Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>.</li> <li> <code>ApproximateNumberOfMessagesNotVisible</code> - returns the approximate number of messages that are not timed-out and not deleted. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html">Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>.</li> <li> <code>VisibilityTimeout</code> - returns the visibility timeout for the queue. For more information about visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.</li> <li> <code>CreatedTimestamp</code> - returns the time when the queue was created (epoch time in seconds).</li> <li> <code>LastModifiedTimestamp</code> - returns the time when the queue was last changed (epoch time in seconds).</li> <li> <code>Policy</code> - returns the queue's policy.</li> <li> <code>MaximumMessageSize</code> - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.</li> <li> <code>MessageRetentionPeriod</code> - returns the number of seconds Amazon SQS retains a message.</li> <li> <code>QueueArn</code> - returns the queue's Amazon resource name (ARN).</li> <li> <code>ApproximateNumberOfMessagesDelayed</code> - returns the approximate number of messages that are pending to be added to the queue.</li> <li> <code>DelaySeconds</code> - returns the default delay on the queue in seconds.</li> <li> <code>ReceiveMessageWaitTimeSeconds</code> - returns the time for which a ReceiveMessage call will wait for a message to arrive.</li> <li> <code>RedrivePolicy</code> - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html">Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>.</li> </ul> <note>Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.</note> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="attributeNames">A list of attributes to retrieve information for. </param> <returns>The response from the GetQueueAttributes service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.InvalidAttributeNameException"> The attribute referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.GetQueueAttributes(Amazon.SQS.Model.GetQueueAttributesRequest)"> <summary> Gets attributes for the specified queue. The following attributes are supported: <ul> <li> <code>All</code> - returns all values.</li> <li> <code>ApproximateNumberOfMessages</code> - returns the approximate number of visible messages in a queue. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html">Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>.</li> <li> <code>ApproximateNumberOfMessagesNotVisible</code> - returns the approximate number of messages that are not timed-out and not deleted. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html">Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>.</li> <li> <code>VisibilityTimeout</code> - returns the visibility timeout for the queue. For more information about visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.</li> <li> <code>CreatedTimestamp</code> - returns the time when the queue was created (epoch time in seconds).</li> <li> <code>LastModifiedTimestamp</code> - returns the time when the queue was last changed (epoch time in seconds).</li> <li> <code>Policy</code> - returns the queue's policy.</li> <li> <code>MaximumMessageSize</code> - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.</li> <li> <code>MessageRetentionPeriod</code> - returns the number of seconds Amazon SQS retains a message.</li> <li> <code>QueueArn</code> - returns the queue's Amazon resource name (ARN).</li> <li> <code>ApproximateNumberOfMessagesDelayed</code> - returns the approximate number of messages that are pending to be added to the queue.</li> <li> <code>DelaySeconds</code> - returns the default delay on the queue in seconds.</li> <li> <code>ReceiveMessageWaitTimeSeconds</code> - returns the time for which a ReceiveMessage call will wait for a message to arrive.</li> <li> <code>RedrivePolicy</code> - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html">Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>.</li> </ul> <note>Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.</note> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="request">Container for the necessary parameters to execute the GetQueueAttributes service method.</param> <returns>The response from the GetQueueAttributes service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.InvalidAttributeNameException"> The attribute referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.GetQueueAttributesAsync(Amazon.SQS.Model.GetQueueAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetQueueAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetQueueAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.GetQueueUrl(System.String)"> <summary> Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue. <para> To access a queue that belongs to another AWS account, use the <code>QueueOwnerAWSAccountId</code> parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see <a>AddPermission</a> or go to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html">Shared Queues</a> in the <i>Amazon SQS Developer Guide</i>. </para> </summary> <param name="queueName">The name of the queue whose URL must be fetched. Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.</param> <returns>The response from the GetQueueUrl service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.QueueDoesNotExistException"> The queue referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.GetQueueUrl(Amazon.SQS.Model.GetQueueUrlRequest)"> <summary> Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue. <para> To access a queue that belongs to another AWS account, use the <code>QueueOwnerAWSAccountId</code> parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see <a>AddPermission</a> or go to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html">Shared Queues</a> in the <i>Amazon SQS Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetQueueUrl service method.</param> <returns>The response from the GetQueueUrl service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.QueueDoesNotExistException"> The queue referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.GetQueueUrlAsync(Amazon.SQS.Model.GetQueueUrlRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetQueueUrl operation. </summary> <param name="request">Container for the necessary parameters to execute the GetQueueUrl operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.ListDeadLetterSourceQueues(Amazon.SQS.Model.ListDeadLetterSourceQueuesRequest)"> <summary> Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue. <para> For more information about using dead letter queues, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html">Using Amazon SQS Dead Letter Queues</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListDeadLetterSourceQueues service method.</param> <returns>The response from the ListDeadLetterSourceQueues service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.QueueDoesNotExistException"> The queue referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.ListDeadLetterSourceQueuesAsync(Amazon.SQS.Model.ListDeadLetterSourceQueuesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDeadLetterSourceQueues operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeadLetterSourceQueues operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.ListQueues(System.String)"> <summary> Returns a list of your queues. The maximum number of queues that can be returned is 1000. If you specify a value for the optional <code>QueueNamePrefix</code> parameter, only queues with a name beginning with the specified value are returned. </summary> <param name="queueNamePrefix">A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.</param> <returns>The response from the ListQueues service method, as returned by SQS.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.ListQueues(Amazon.SQS.Model.ListQueuesRequest)"> <summary> Returns a list of your queues. The maximum number of queues that can be returned is 1000. If you specify a value for the optional <code>QueueNamePrefix</code> parameter, only queues with a name beginning with the specified value are returned. </summary> <param name="request">Container for the necessary parameters to execute the ListQueues service method.</param> <returns>The response from the ListQueues service method, as returned by SQS.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.ListQueuesAsync(Amazon.SQS.Model.ListQueuesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListQueues operation. </summary> <param name="request">Container for the necessary parameters to execute the ListQueues operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.PurgeQueue(System.String)"> <summary> Deletes the messages in a queue specified by the <b>queue URL</b>. <important>When you use the <code>PurgeQueue</code> API, the deleted messages in the queue cannot be retrieved.</important> <para> When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling <code>PurgeQueue</code> will be deleted; messages sent to the queue while it is being purged may be deleted. While the queue is being purged, messages sent to the queue before <code>PurgeQueue</code> was called may be received, but will be deleted within the next minute. </para> </summary> <param name="queueUrl">The queue URL of the queue to delete the messages from when using the <code>PurgeQueue</code> API.</param> <returns>The response from the PurgeQueue service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.PurgeQueueInProgressException"> Indicates that the specified queue previously received a <code>PurgeQueue</code> request within the last 60 seconds, the time it can take to delete the messages in the queue. </exception> <exception cref="T:Amazon.SQS.Model.QueueDoesNotExistException"> The queue referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.PurgeQueue(Amazon.SQS.Model.PurgeQueueRequest)"> <summary> Deletes the messages in a queue specified by the <b>queue URL</b>. <important>When you use the <code>PurgeQueue</code> API, the deleted messages in the queue cannot be retrieved.</important> <para> When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling <code>PurgeQueue</code> will be deleted; messages sent to the queue while it is being purged may be deleted. While the queue is being purged, messages sent to the queue before <code>PurgeQueue</code> was called may be received, but will be deleted within the next minute. </para> </summary> <param name="request">Container for the necessary parameters to execute the PurgeQueue service method.</param> <returns>The response from the PurgeQueue service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.PurgeQueueInProgressException"> Indicates that the specified queue previously received a <code>PurgeQueue</code> request within the last 60 seconds, the time it can take to delete the messages in the queue. </exception> <exception cref="T:Amazon.SQS.Model.QueueDoesNotExistException"> The queue referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.PurgeQueueAsync(Amazon.SQS.Model.PurgeQueueRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PurgeQueue operation. </summary> <param name="request">Container for the necessary parameters to execute the PurgeQueue operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.ReceiveMessage(System.String)"> <summary> Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue. Long poll support is enabled by using the <code>WaitTimeSeconds</code> parameter. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html">Amazon SQS Long Poll</a> in the <i>Amazon SQS Developer Guide</i>. <para> Short poll is the default behavior where a weighted random set of machines is sampled on a <code>ReceiveMessage</code> call. This means only the messages on the sampled machines are returned. If the number of messages in the queue is small (less than 1000), it is likely you will get fewer messages than you requested per <code>ReceiveMessage</code> call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular <code>ReceiveMessage</code> response; in which case you should repeat the request. </para> <para> For each message returned, the response includes the following: </para> <ul> <li> <para> Message body </para> </li> <li> <para> MD5 digest of the message body. For information about MD5, go to <a href="http://www.faqs.org/rfcs/rfc1321.html">http://www.faqs.org/rfcs/rfc1321.html</a>. </para> </li> <li> <para> Message ID you received when you sent the message to the queue. </para> </li> <li> <para> Receipt handle. </para> </li> <li> <para> Message attributes. </para> </li> <li> <para> MD5 digest of the message attributes. </para> </li> </ul> <para> The receipt handle is the identifier you must provide when deleting the message. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html">Queue and Message Identifiers</a> in the <i>Amazon SQS Developer Guide</i>. </para> <para> You can provide the <code>VisibilityTimeout</code> parameter in your request, which will be applied to the messages that Amazon SQS returns in the response. If you do not include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. </para> <note> <para> Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. </para> </note> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <returns>The response from the ReceiveMessage service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.OverLimitException"> The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of messages inflight has already been reached. <a>AddPermission</a> returns this error if the maximum number of permissions for the queue has already been reached. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.ReceiveMessage(Amazon.SQS.Model.ReceiveMessageRequest)"> <summary> Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue. Long poll support is enabled by using the <code>WaitTimeSeconds</code> parameter. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html">Amazon SQS Long Poll</a> in the <i>Amazon SQS Developer Guide</i>. <para> Short poll is the default behavior where a weighted random set of machines is sampled on a <code>ReceiveMessage</code> call. This means only the messages on the sampled machines are returned. If the number of messages in the queue is small (less than 1000), it is likely you will get fewer messages than you requested per <code>ReceiveMessage</code> call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular <code>ReceiveMessage</code> response; in which case you should repeat the request. </para> <para> For each message returned, the response includes the following: </para> <ul> <li> <para> Message body </para> </li> <li> <para> MD5 digest of the message body. For information about MD5, go to <a href="http://www.faqs.org/rfcs/rfc1321.html">http://www.faqs.org/rfcs/rfc1321.html</a>. </para> </li> <li> <para> Message ID you received when you sent the message to the queue. </para> </li> <li> <para> Receipt handle. </para> </li> <li> <para> Message attributes. </para> </li> <li> <para> MD5 digest of the message attributes. </para> </li> </ul> <para> The receipt handle is the identifier you must provide when deleting the message. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html">Queue and Message Identifiers</a> in the <i>Amazon SQS Developer Guide</i>. </para> <para> You can provide the <code>VisibilityTimeout</code> parameter in your request, which will be applied to the messages that Amazon SQS returns in the response. If you do not include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. </para> <note> <para> Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ReceiveMessage service method.</param> <returns>The response from the ReceiveMessage service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.OverLimitException"> The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of messages inflight has already been reached. <a>AddPermission</a> returns this error if the maximum number of permissions for the queue has already been reached. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.ReceiveMessageAsync(Amazon.SQS.Model.ReceiveMessageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReceiveMessage operation. </summary> <param name="request">Container for the necessary parameters to execute the ReceiveMessage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.RemovePermission(System.String,System.String)"> <summary> Revokes any permissions in the queue policy that matches the specified <code>Label</code> parameter. Only the owner of the queue can remove permissions. </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="label">The identification of the permission to remove. This is the label added with the <a>AddPermission</a> action.</param> <returns>The response from the RemovePermission service method, as returned by SQS.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.RemovePermission(Amazon.SQS.Model.RemovePermissionRequest)"> <summary> Revokes any permissions in the queue policy that matches the specified <code>Label</code> parameter. Only the owner of the queue can remove permissions. </summary> <param name="request">Container for the necessary parameters to execute the RemovePermission service method.</param> <returns>The response from the RemovePermission service method, as returned by SQS.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.RemovePermissionAsync(Amazon.SQS.Model.RemovePermissionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemovePermission operation. </summary> <param name="request">Container for the necessary parameters to execute the RemovePermission operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.SendMessage(System.String,System.String)"> <summary> Delivers a message to the specified queue. With Amazon SQS, you now have the ability to send large payload messages that are up to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that supports SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK release notes. <important> <para> The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to <a href="http://www.w3.org/TR/REC-xml/#charsets">http://www.w3.org/TR/REC-xml/#charsets</a> If you send any characters not included in the list, your request will be rejected. </para> <para> #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF] </para> </important> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="messageBody">The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.</param> <returns>The response from the SendMessage service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.InvalidMessageContentsException"> The message contains characters outside the allowed set. </exception> <exception cref="T:Amazon.SQS.Model.UnsupportedOperationException"> Error code 400. Unsupported operation. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.SendMessage(Amazon.SQS.Model.SendMessageRequest)"> <summary> Delivers a message to the specified queue. With Amazon SQS, you now have the ability to send large payload messages that are up to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that supports SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK release notes. <important> <para> The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to <a href="http://www.w3.org/TR/REC-xml/#charsets">http://www.w3.org/TR/REC-xml/#charsets</a> If you send any characters not included in the list, your request will be rejected. </para> <para> #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF] </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the SendMessage service method.</param> <returns>The response from the SendMessage service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.InvalidMessageContentsException"> The message contains characters outside the allowed set. </exception> <exception cref="T:Amazon.SQS.Model.UnsupportedOperationException"> Error code 400. Unsupported operation. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.SendMessageAsync(Amazon.SQS.Model.SendMessageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SendMessage operation. </summary> <param name="request">Container for the necessary parameters to execute the SendMessage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.SendMessageBatch(System.String,System.Collections.Generic.List{Amazon.SQS.Model.SendMessageBatchRequestEntry})"> <summary> Delivers up to ten messages to the specified queue. This is a batch version of <a>SendMessage</a>. The result of the send action on each message is reported individually in the response. The maximum allowed individual message size is 256 KB (262,144 bytes). <para> The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes). </para> <para> If the <code>DelaySeconds</code> parameter is not specified for an entry, the default for the queue is used. </para> <important>The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification. For more information, go to <a href="http://www.faqs.org/rfcs/rfc1321.html">http://www.faqs.org/rfcs/rfc1321.html</a>. If you send any characters that are not included in the list, your request will be rejected. <para> #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF] </para> </important> <important> Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. </important> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="entries">A list of <a>SendMessageBatchRequestEntry</a> items.</param> <returns>The response from the SendMessageBatch service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.BatchEntryIdsNotDistinctException"> Two or more batch entries have the same <code>Id</code> in the request. </exception> <exception cref="T:Amazon.SQS.Model.BatchRequestTooLongException"> The length of all the messages put together is more than the limit. </exception> <exception cref="T:Amazon.SQS.Model.EmptyBatchRequestException"> Batch request does not contain an entry. </exception> <exception cref="T:Amazon.SQS.Model.InvalidBatchEntryIdException"> The <code>Id</code> of a batch entry in a batch request does not abide by the specification. </exception> <exception cref="T:Amazon.SQS.Model.TooManyEntriesInBatchRequestException"> Batch request contains more number of entries than permissible. </exception> <exception cref="T:Amazon.SQS.Model.UnsupportedOperationException"> Error code 400. Unsupported operation. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.SendMessageBatch(Amazon.SQS.Model.SendMessageBatchRequest)"> <summary> Delivers up to ten messages to the specified queue. This is a batch version of <a>SendMessage</a>. The result of the send action on each message is reported individually in the response. The maximum allowed individual message size is 256 KB (262,144 bytes). <para> The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes). </para> <para> If the <code>DelaySeconds</code> parameter is not specified for an entry, the default for the queue is used. </para> <important>The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification. For more information, go to <a href="http://www.faqs.org/rfcs/rfc1321.html">http://www.faqs.org/rfcs/rfc1321.html</a>. If you send any characters that are not included in the list, your request will be rejected. <para> #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF] </para> </important> <important> Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. </important> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="request">Container for the necessary parameters to execute the SendMessageBatch service method.</param> <returns>The response from the SendMessageBatch service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.BatchEntryIdsNotDistinctException"> Two or more batch entries have the same <code>Id</code> in the request. </exception> <exception cref="T:Amazon.SQS.Model.BatchRequestTooLongException"> The length of all the messages put together is more than the limit. </exception> <exception cref="T:Amazon.SQS.Model.EmptyBatchRequestException"> Batch request does not contain an entry. </exception> <exception cref="T:Amazon.SQS.Model.InvalidBatchEntryIdException"> The <code>Id</code> of a batch entry in a batch request does not abide by the specification. </exception> <exception cref="T:Amazon.SQS.Model.TooManyEntriesInBatchRequestException"> Batch request contains more number of entries than permissible. </exception> <exception cref="T:Amazon.SQS.Model.UnsupportedOperationException"> Error code 400. Unsupported operation. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.SendMessageBatchAsync(Amazon.SQS.Model.SendMessageBatchRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SendMessageBatch operation. </summary> <param name="request">Container for the necessary parameters to execute the SendMessageBatch operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.SetQueueAttributes(System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the SQS system. Changes made to the <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes. <note>Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.</note> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="attributes">A map of attributes to set. The following lists the names, descriptions, and values of the special request parameters the <code>SetQueueAttributes</code> action uses: <ul> <li> <code>DelaySeconds</code> - The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero).</li> <li> <code>MaximumMessageSize</code> - The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).</li> <li> <code>MessageRetentionPeriod</code> - The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).</li> <li> <code>Policy</code> - The queue's policy. A valid AWS policy. For more information about policy structure, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>.</li> <li> <code>ReceiveMessageWaitTimeSeconds</code> - The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0. </li> <li> <code>VisibilityTimeout</code> - The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the <i>Amazon SQS Developer Guide</i>.</li> <li> <code>RedrivePolicy</code> - The parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the <i>Amazon SQS Developer Guide</i>.</li> </ul> </param> <returns>The response from the SetQueueAttributes service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.InvalidAttributeNameException"> The attribute referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.SetQueueAttributes(Amazon.SQS.Model.SetQueueAttributesRequest)"> <summary> Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the SQS system. Changes made to the <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes. <note>Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.</note> </summary> <param name="request">Container for the necessary parameters to execute the SetQueueAttributes service method.</param> <returns>The response from the SetQueueAttributes service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.InvalidAttributeNameException"> The attribute referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.IAmazonSQS.SetQueueAttributesAsync(Amazon.SQS.Model.SetQueueAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetQueueAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the SetQueueAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.IAmazonSQS.AuthorizeS3ToSendMessage(System.String,System.String)"> <summary> This is a utility method which updates the policy of a queue to allow the S3 bucket to publish events to it. </summary> <param name="queueUrl">The queue that will have its policy updated.</param> <param name="bucket">The bucket that will be given access to send messages from.</param> <returns>The ARN for the SQS queue. This can be used when setting up the S3 bucket notification.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.#ctor"> <summary> Constructs AmazonSQSClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.SQS.AmazonSQSClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonSQSClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SQS.AmazonSQSClient.#ctor(Amazon.SQS.AmazonSQSConfig)"> <summary> Constructs AmazonSQSClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonSQSClient Configuration Object</param> </member> <member name="M:Amazon.SQS.AmazonSQSClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonSQSClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.SQS.AmazonSQSClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSQSClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SQS.AmazonSQSClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.SQS.AmazonSQSConfig)"> <summary> Constructs AmazonSQSClient with AWS Credentials and an AmazonSQSClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonSQSClient Configuration Object</param> </member> <member name="M:Amazon.SQS.AmazonSQSClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.SQS.AmazonSQSClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SQS.AmazonSQSClient.#ctor(System.String,System.String,Amazon.SQS.AmazonSQSConfig)"> <summary> Constructs AmazonSQSClient with AWS Access Key ID, AWS Secret Key and an AmazonSQSClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonSQSClient Configuration Object</param> </member> <member name="M:Amazon.SQS.AmazonSQSClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.SQS.AmazonSQSClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSQSClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SQS.AmazonSQSClient.#ctor(System.String,System.String,System.String,Amazon.SQS.AmazonSQSConfig)"> <summary> Constructs AmazonSQSClient with AWS Access Key ID, AWS Secret Key and an AmazonSQSClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonSQSClient Configuration Object</param> </member> <member name="M:Amazon.SQS.AmazonSQSClient.AddPermission(System.String,System.String,System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String})"> <summary> Adds a permission to a queue for a specific <a href="http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principal</a>. This allows for sharing access to the queue. <para> When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html">Shared Queues</a> in the <i>Amazon SQS Developer Guide</i>. </para> <note> <para> <code>AddPermission</code> writes an Amazon SQS-generated policy. If you want to write your own policy, use <a>SetQueueAttributes</a> to upload your policy. For more information about writing your own policy, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AccessPolicyLanguage.html">Using The Access Policy Language</a> in the <i>Amazon SQS Developer Guide</i>. </para> </note> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="label">The unique identification of the permission you're setting (e.g., <code>AliceSendMessage</code>). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.</param> <param name="awsAccountIds">The AWS account number of the <a href="http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principal</a> who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AWSCredentials.html">Your AWS Identifiers</a> in the <i>Amazon SQS Developer Guide</i>.</param> <param name="actions">The action the client wants to allow for the specified principal. The following are valid values: <code>* | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl</code>. For more information about these actions, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html#PermissionTypes">Understanding Permissions</a> in the <i>Amazon SQS Developer Guide</i>. Specifying <code>SendMessage</code>, <code>DeleteMessage</code>, or <code>ChangeMessageVisibility</code> for the <code>ActionName.n</code> also grants permissions for the corresponding batch versions of those actions: <code>SendMessageBatch</code>, <code>DeleteMessageBatch</code>, and <code>ChangeMessageVisibilityBatch</code>.</param> <returns>The response from the AddPermission service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.OverLimitException"> The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of messages inflight has already been reached. <a>AddPermission</a> returns this error if the maximum number of permissions for the queue has already been reached. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.AddPermission(Amazon.SQS.Model.AddPermissionRequest)"> <summary> Adds a permission to a queue for a specific <a href="http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principal</a>. This allows for sharing access to the queue. <para> When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html">Shared Queues</a> in the <i>Amazon SQS Developer Guide</i>. </para> <note> <para> <code>AddPermission</code> writes an Amazon SQS-generated policy. If you want to write your own policy, use <a>SetQueueAttributes</a> to upload your policy. For more information about writing your own policy, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AccessPolicyLanguage.html">Using The Access Policy Language</a> in the <i>Amazon SQS Developer Guide</i>. </para> </note> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="request">Container for the necessary parameters to execute the AddPermission service method.</param> <returns>The response from the AddPermission service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.OverLimitException"> The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of messages inflight has already been reached. <a>AddPermission</a> returns this error if the maximum number of permissions for the queue has already been reached. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.AddPermissionAsync(Amazon.SQS.Model.AddPermissionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddPermission operation. </summary> <param name="request">Container for the necessary parameters to execute the AddPermission operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.ChangeMessageVisibility(System.String,System.String,System.Int32)"> <summary> Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.) <para> For example, let's say you have a message and its default message visibility timeout is 30 minutes. You could call <code>ChangeMessageVisiblity</code> with a value of two hours and the effective timeout would be two hours and 30 minutes. When that time comes near you could again extend the time out by calling ChangeMessageVisiblity, but this time the maximum allowed timeout would be 9 hours and 30 minutes. </para> <note> <para> There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages. </para> </note> <important>If you attempt to set the <code>VisibilityTimeout</code> to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.</important> <important>Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the <code>ChangeMessageVisibility</code> action.</important> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="receiptHandle">The receipt handle associated with the message whose visibility timeout should be changed. This parameter is returned by the <a>ReceiveMessage</a> action.</param> <param name="visibilityTimeout">The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.</param> <returns>The response from the ChangeMessageVisibility service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.MessageNotInflightException"> The message referred to is not in flight. </exception> <exception cref="T:Amazon.SQS.Model.ReceiptHandleIsInvalidException"> The receipt handle provided is not valid. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.ChangeMessageVisibility(Amazon.SQS.Model.ChangeMessageVisibilityRequest)"> <summary> Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.) <para> For example, let's say you have a message and its default message visibility timeout is 30 minutes. You could call <code>ChangeMessageVisiblity</code> with a value of two hours and the effective timeout would be two hours and 30 minutes. When that time comes near you could again extend the time out by calling ChangeMessageVisiblity, but this time the maximum allowed timeout would be 9 hours and 30 minutes. </para> <note> <para> There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages. </para> </note> <important>If you attempt to set the <code>VisibilityTimeout</code> to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.</important> <important>Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the <code>ChangeMessageVisibility</code> action.</important> </summary> <param name="request">Container for the necessary parameters to execute the ChangeMessageVisibility service method.</param> <returns>The response from the ChangeMessageVisibility service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.MessageNotInflightException"> The message referred to is not in flight. </exception> <exception cref="T:Amazon.SQS.Model.ReceiptHandleIsInvalidException"> The receipt handle provided is not valid. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.ChangeMessageVisibilityAsync(Amazon.SQS.Model.ChangeMessageVisibilityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ChangeMessageVisibility operation. </summary> <param name="request">Container for the necessary parameters to execute the ChangeMessageVisibility operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.ChangeMessageVisibilityBatch(System.String,System.Collections.Generic.List{Amazon.SQS.Model.ChangeMessageVisibilityBatchRequestEntry})"> <summary> Changes the visibility timeout of multiple messages. This is a batch version of <a>ChangeMessageVisibility</a>. The result of the action on each message is reported individually in the response. You can send up to 10 <a>ChangeMessageVisibility</a> requests with each <code>ChangeMessageVisibilityBatch</code> action. <important>Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.</important> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="entries">A list of receipt handles of the messages for which the visibility timeout must be changed.</param> <returns>The response from the ChangeMessageVisibilityBatch service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.BatchEntryIdsNotDistinctException"> Two or more batch entries have the same <code>Id</code> in the request. </exception> <exception cref="T:Amazon.SQS.Model.EmptyBatchRequestException"> Batch request does not contain an entry. </exception> <exception cref="T:Amazon.SQS.Model.InvalidBatchEntryIdException"> The <code>Id</code> of a batch entry in a batch request does not abide by the specification. </exception> <exception cref="T:Amazon.SQS.Model.TooManyEntriesInBatchRequestException"> Batch request contains more number of entries than permissible. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.ChangeMessageVisibilityBatch(Amazon.SQS.Model.ChangeMessageVisibilityBatchRequest)"> <summary> Changes the visibility timeout of multiple messages. This is a batch version of <a>ChangeMessageVisibility</a>. The result of the action on each message is reported individually in the response. You can send up to 10 <a>ChangeMessageVisibility</a> requests with each <code>ChangeMessageVisibilityBatch</code> action. <important>Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.</important> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="request">Container for the necessary parameters to execute the ChangeMessageVisibilityBatch service method.</param> <returns>The response from the ChangeMessageVisibilityBatch service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.BatchEntryIdsNotDistinctException"> Two or more batch entries have the same <code>Id</code> in the request. </exception> <exception cref="T:Amazon.SQS.Model.EmptyBatchRequestException"> Batch request does not contain an entry. </exception> <exception cref="T:Amazon.SQS.Model.InvalidBatchEntryIdException"> The <code>Id</code> of a batch entry in a batch request does not abide by the specification. </exception> <exception cref="T:Amazon.SQS.Model.TooManyEntriesInBatchRequestException"> Batch request contains more number of entries than permissible. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.ChangeMessageVisibilityBatchAsync(Amazon.SQS.Model.ChangeMessageVisibilityBatchRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ChangeMessageVisibilityBatch operation. </summary> <param name="request">Container for the necessary parameters to execute the ChangeMessageVisibilityBatch operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.CreateQueue(System.String)"> <summary> Creates a new queue, or returns the URL of an existing one. When you request <code>CreateQueue</code>, you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues. <note> <para> If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. </para> </note> <para> You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute. Permitted attributes are the same that can be set using <a>SetQueueAttributes</a>. </para> <note> <para> Use <a>GetQueueUrl</a> to get a queue's URL. <a>GetQueueUrl</a> requires only the <code>QueueName</code> parameter. </para> </note> <para> If you provide the name of an existing queue, along with the exact names and values of all the queue's attributes, <code>CreateQueue</code> returns the queue URL for the existing queue. If the queue name, attribute names, or attribute values do not match an existing queue, <code>CreateQueue</code> returns an error. </para> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="queueName">The name for the queue to be created.</param> <returns>The response from the CreateQueue service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.QueueDeletedRecentlyException"> You must wait 60 seconds after deleting a queue before you can create another with the same name. </exception> <exception cref="T:Amazon.SQS.Model.QueueNameExistsException"> A queue already exists with this name. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.CreateQueue(Amazon.SQS.Model.CreateQueueRequest)"> <summary> Creates a new queue, or returns the URL of an existing one. When you request <code>CreateQueue</code>, you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues. <note> <para> If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. </para> </note> <para> You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute. Permitted attributes are the same that can be set using <a>SetQueueAttributes</a>. </para> <note> <para> Use <a>GetQueueUrl</a> to get a queue's URL. <a>GetQueueUrl</a> requires only the <code>QueueName</code> parameter. </para> </note> <para> If you provide the name of an existing queue, along with the exact names and values of all the queue's attributes, <code>CreateQueue</code> returns the queue URL for the existing queue. If the queue name, attribute names, or attribute values do not match an existing queue, <code>CreateQueue</code> returns an error. </para> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateQueue service method.</param> <returns>The response from the CreateQueue service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.QueueDeletedRecentlyException"> You must wait 60 seconds after deleting a queue before you can create another with the same name. </exception> <exception cref="T:Amazon.SQS.Model.QueueNameExistsException"> A queue already exists with this name. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.CreateQueueAsync(Amazon.SQS.Model.CreateQueueRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateQueue operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateQueue operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.DeleteMessage(System.String,System.String)"> <summary> Deletes the specified message from the specified queue. You specify the message by using the message's <code>receipt handle</code> and not the <code>message ID</code> you received when you sent the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes it. <note> <para> The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. When you request <code>DeleteMessage</code>, if you don't provide the most recently received receipt handle for the message, the request will still succeed, but the message might not be deleted. </para> </note> <important> <para> It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem. </para> </important> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="receiptHandle">The receipt handle associated with the message to delete.</param> <returns>The response from the DeleteMessage service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.InvalidIdFormatException"> The receipt handle is not valid for the current version. </exception> <exception cref="T:Amazon.SQS.Model.ReceiptHandleIsInvalidException"> The receipt handle provided is not valid. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.DeleteMessage(Amazon.SQS.Model.DeleteMessageRequest)"> <summary> Deletes the specified message from the specified queue. You specify the message by using the message's <code>receipt handle</code> and not the <code>message ID</code> you received when you sent the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes it. <note> <para> The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. When you request <code>DeleteMessage</code>, if you don't provide the most recently received receipt handle for the message, the request will still succeed, but the message might not be deleted. </para> </note> <important> <para> It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteMessage service method.</param> <returns>The response from the DeleteMessage service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.InvalidIdFormatException"> The receipt handle is not valid for the current version. </exception> <exception cref="T:Amazon.SQS.Model.ReceiptHandleIsInvalidException"> The receipt handle provided is not valid. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.DeleteMessageAsync(Amazon.SQS.Model.DeleteMessageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteMessage operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteMessage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.DeleteMessageBatch(System.String,System.Collections.Generic.List{Amazon.SQS.Model.DeleteMessageBatchRequestEntry})"> <summary> Deletes up to ten messages from the specified queue. This is a batch version of <a>DeleteMessage</a>. The result of the delete action on each message is reported individually in the response. <important> <para> Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. </para> </important> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="entries">A list of receipt handles for the messages to be deleted.</param> <returns>The response from the DeleteMessageBatch service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.BatchEntryIdsNotDistinctException"> Two or more batch entries have the same <code>Id</code> in the request. </exception> <exception cref="T:Amazon.SQS.Model.EmptyBatchRequestException"> Batch request does not contain an entry. </exception> <exception cref="T:Amazon.SQS.Model.InvalidBatchEntryIdException"> The <code>Id</code> of a batch entry in a batch request does not abide by the specification. </exception> <exception cref="T:Amazon.SQS.Model.TooManyEntriesInBatchRequestException"> Batch request contains more number of entries than permissible. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.DeleteMessageBatch(Amazon.SQS.Model.DeleteMessageBatchRequest)"> <summary> Deletes up to ten messages from the specified queue. This is a batch version of <a>DeleteMessage</a>. The result of the delete action on each message is reported individually in the response. <important> <para> Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. </para> </important> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteMessageBatch service method.</param> <returns>The response from the DeleteMessageBatch service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.BatchEntryIdsNotDistinctException"> Two or more batch entries have the same <code>Id</code> in the request. </exception> <exception cref="T:Amazon.SQS.Model.EmptyBatchRequestException"> Batch request does not contain an entry. </exception> <exception cref="T:Amazon.SQS.Model.InvalidBatchEntryIdException"> The <code>Id</code> of a batch entry in a batch request does not abide by the specification. </exception> <exception cref="T:Amazon.SQS.Model.TooManyEntriesInBatchRequestException"> Batch request contains more number of entries than permissible. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.DeleteMessageBatchAsync(Amazon.SQS.Model.DeleteMessageBatchRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteMessageBatch operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteMessageBatch operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.DeleteQueue(System.String)"> <summary> Deletes the queue specified by the <b>queue URL</b>, regardless of whether the queue is empty. If the specified queue does not exist, Amazon SQS returns a successful response. <important> <para> Use <code>DeleteQueue</code> with care; once you delete your queue, any messages in the queue are no longer available. </para> </important> <para> When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a <a>SendMessage</a> request might succeed, but after the 60 seconds, the queue and that message you sent no longer exist. Also, when you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. </para> <para> We reserve the right to delete queues that have had no activity for more than 30 days. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSConcepts.html">How Amazon SQS Queues Work</a> in the <i>Amazon SQS Developer Guide</i>. </para> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <returns>The response from the DeleteQueue service method, as returned by SQS.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.DeleteQueue(Amazon.SQS.Model.DeleteQueueRequest)"> <summary> Deletes the queue specified by the <b>queue URL</b>, regardless of whether the queue is empty. If the specified queue does not exist, Amazon SQS returns a successful response. <important> <para> Use <code>DeleteQueue</code> with care; once you delete your queue, any messages in the queue are no longer available. </para> </important> <para> When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a <a>SendMessage</a> request might succeed, but after the 60 seconds, the queue and that message you sent no longer exist. Also, when you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. </para> <para> We reserve the right to delete queues that have had no activity for more than 30 days. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSConcepts.html">How Amazon SQS Queues Work</a> in the <i>Amazon SQS Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteQueue service method.</param> <returns>The response from the DeleteQueue service method, as returned by SQS.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.DeleteQueueAsync(Amazon.SQS.Model.DeleteQueueRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteQueue operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteQueue operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.GetQueueAttributes(System.String,System.Collections.Generic.List{System.String})"> <summary> Gets attributes for the specified queue. The following attributes are supported: <ul> <li> <code>All</code> - returns all values.</li> <li> <code>ApproximateNumberOfMessages</code> - returns the approximate number of visible messages in a queue. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html">Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>.</li> <li> <code>ApproximateNumberOfMessagesNotVisible</code> - returns the approximate number of messages that are not timed-out and not deleted. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html">Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>.</li> <li> <code>VisibilityTimeout</code> - returns the visibility timeout for the queue. For more information about visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.</li> <li> <code>CreatedTimestamp</code> - returns the time when the queue was created (epoch time in seconds).</li> <li> <code>LastModifiedTimestamp</code> - returns the time when the queue was last changed (epoch time in seconds).</li> <li> <code>Policy</code> - returns the queue's policy.</li> <li> <code>MaximumMessageSize</code> - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.</li> <li> <code>MessageRetentionPeriod</code> - returns the number of seconds Amazon SQS retains a message.</li> <li> <code>QueueArn</code> - returns the queue's Amazon resource name (ARN).</li> <li> <code>ApproximateNumberOfMessagesDelayed</code> - returns the approximate number of messages that are pending to be added to the queue.</li> <li> <code>DelaySeconds</code> - returns the default delay on the queue in seconds.</li> <li> <code>ReceiveMessageWaitTimeSeconds</code> - returns the time for which a ReceiveMessage call will wait for a message to arrive.</li> <li> <code>RedrivePolicy</code> - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html">Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>.</li> </ul> <note>Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.</note> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="attributeNames">A list of attributes to retrieve information for. </param> <returns>The response from the GetQueueAttributes service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.InvalidAttributeNameException"> The attribute referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.GetQueueAttributes(Amazon.SQS.Model.GetQueueAttributesRequest)"> <summary> Gets attributes for the specified queue. The following attributes are supported: <ul> <li> <code>All</code> - returns all values.</li> <li> <code>ApproximateNumberOfMessages</code> - returns the approximate number of visible messages in a queue. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html">Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>.</li> <li> <code>ApproximateNumberOfMessagesNotVisible</code> - returns the approximate number of messages that are not timed-out and not deleted. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html">Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>.</li> <li> <code>VisibilityTimeout</code> - returns the visibility timeout for the queue. For more information about visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.</li> <li> <code>CreatedTimestamp</code> - returns the time when the queue was created (epoch time in seconds).</li> <li> <code>LastModifiedTimestamp</code> - returns the time when the queue was last changed (epoch time in seconds).</li> <li> <code>Policy</code> - returns the queue's policy.</li> <li> <code>MaximumMessageSize</code> - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.</li> <li> <code>MessageRetentionPeriod</code> - returns the number of seconds Amazon SQS retains a message.</li> <li> <code>QueueArn</code> - returns the queue's Amazon resource name (ARN).</li> <li> <code>ApproximateNumberOfMessagesDelayed</code> - returns the approximate number of messages that are pending to be added to the queue.</li> <li> <code>DelaySeconds</code> - returns the default delay on the queue in seconds.</li> <li> <code>ReceiveMessageWaitTimeSeconds</code> - returns the time for which a ReceiveMessage call will wait for a message to arrive.</li> <li> <code>RedrivePolicy</code> - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html">Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>.</li> </ul> <note>Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.</note> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="request">Container for the necessary parameters to execute the GetQueueAttributes service method.</param> <returns>The response from the GetQueueAttributes service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.InvalidAttributeNameException"> The attribute referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.GetQueueAttributesAsync(Amazon.SQS.Model.GetQueueAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetQueueAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the GetQueueAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.GetQueueUrl(System.String)"> <summary> Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue. <para> To access a queue that belongs to another AWS account, use the <code>QueueOwnerAWSAccountId</code> parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see <a>AddPermission</a> or go to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html">Shared Queues</a> in the <i>Amazon SQS Developer Guide</i>. </para> </summary> <param name="queueName">The name of the queue whose URL must be fetched. Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.</param> <returns>The response from the GetQueueUrl service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.QueueDoesNotExistException"> The queue referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.GetQueueUrl(Amazon.SQS.Model.GetQueueUrlRequest)"> <summary> Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue. <para> To access a queue that belongs to another AWS account, use the <code>QueueOwnerAWSAccountId</code> parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see <a>AddPermission</a> or go to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html">Shared Queues</a> in the <i>Amazon SQS Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetQueueUrl service method.</param> <returns>The response from the GetQueueUrl service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.QueueDoesNotExistException"> The queue referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.GetQueueUrlAsync(Amazon.SQS.Model.GetQueueUrlRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetQueueUrl operation. </summary> <param name="request">Container for the necessary parameters to execute the GetQueueUrl operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.ListDeadLetterSourceQueues(Amazon.SQS.Model.ListDeadLetterSourceQueuesRequest)"> <summary> Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue. <para> For more information about using dead letter queues, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html">Using Amazon SQS Dead Letter Queues</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListDeadLetterSourceQueues service method.</param> <returns>The response from the ListDeadLetterSourceQueues service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.QueueDoesNotExistException"> The queue referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.ListDeadLetterSourceQueuesAsync(Amazon.SQS.Model.ListDeadLetterSourceQueuesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListDeadLetterSourceQueues operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeadLetterSourceQueues operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.ListQueues(System.String)"> <summary> Returns a list of your queues. The maximum number of queues that can be returned is 1000. If you specify a value for the optional <code>QueueNamePrefix</code> parameter, only queues with a name beginning with the specified value are returned. </summary> <param name="queueNamePrefix">A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.</param> <returns>The response from the ListQueues service method, as returned by SQS.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.ListQueues(Amazon.SQS.Model.ListQueuesRequest)"> <summary> Returns a list of your queues. The maximum number of queues that can be returned is 1000. If you specify a value for the optional <code>QueueNamePrefix</code> parameter, only queues with a name beginning with the specified value are returned. </summary> <param name="request">Container for the necessary parameters to execute the ListQueues service method.</param> <returns>The response from the ListQueues service method, as returned by SQS.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.ListQueuesAsync(Amazon.SQS.Model.ListQueuesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListQueues operation. </summary> <param name="request">Container for the necessary parameters to execute the ListQueues operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.PurgeQueue(System.String)"> <summary> Deletes the messages in a queue specified by the <b>queue URL</b>. <important>When you use the <code>PurgeQueue</code> API, the deleted messages in the queue cannot be retrieved.</important> <para> When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling <code>PurgeQueue</code> will be deleted; messages sent to the queue while it is being purged may be deleted. While the queue is being purged, messages sent to the queue before <code>PurgeQueue</code> was called may be received, but will be deleted within the next minute. </para> </summary> <param name="queueUrl">The queue URL of the queue to delete the messages from when using the <code>PurgeQueue</code> API.</param> <returns>The response from the PurgeQueue service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.PurgeQueueInProgressException"> Indicates that the specified queue previously received a <code>PurgeQueue</code> request within the last 60 seconds, the time it can take to delete the messages in the queue. </exception> <exception cref="T:Amazon.SQS.Model.QueueDoesNotExistException"> The queue referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.PurgeQueue(Amazon.SQS.Model.PurgeQueueRequest)"> <summary> Deletes the messages in a queue specified by the <b>queue URL</b>. <important>When you use the <code>PurgeQueue</code> API, the deleted messages in the queue cannot be retrieved.</important> <para> When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling <code>PurgeQueue</code> will be deleted; messages sent to the queue while it is being purged may be deleted. While the queue is being purged, messages sent to the queue before <code>PurgeQueue</code> was called may be received, but will be deleted within the next minute. </para> </summary> <param name="request">Container for the necessary parameters to execute the PurgeQueue service method.</param> <returns>The response from the PurgeQueue service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.PurgeQueueInProgressException"> Indicates that the specified queue previously received a <code>PurgeQueue</code> request within the last 60 seconds, the time it can take to delete the messages in the queue. </exception> <exception cref="T:Amazon.SQS.Model.QueueDoesNotExistException"> The queue referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.PurgeQueueAsync(Amazon.SQS.Model.PurgeQueueRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the PurgeQueue operation. </summary> <param name="request">Container for the necessary parameters to execute the PurgeQueue operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.ReceiveMessage(System.String)"> <summary> Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue. Long poll support is enabled by using the <code>WaitTimeSeconds</code> parameter. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html">Amazon SQS Long Poll</a> in the <i>Amazon SQS Developer Guide</i>. <para> Short poll is the default behavior where a weighted random set of machines is sampled on a <code>ReceiveMessage</code> call. This means only the messages on the sampled machines are returned. If the number of messages in the queue is small (less than 1000), it is likely you will get fewer messages than you requested per <code>ReceiveMessage</code> call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular <code>ReceiveMessage</code> response; in which case you should repeat the request. </para> <para> For each message returned, the response includes the following: </para> <ul> <li> <para> Message body </para> </li> <li> <para> MD5 digest of the message body. For information about MD5, go to <a href="http://www.faqs.org/rfcs/rfc1321.html">http://www.faqs.org/rfcs/rfc1321.html</a>. </para> </li> <li> <para> Message ID you received when you sent the message to the queue. </para> </li> <li> <para> Receipt handle. </para> </li> <li> <para> Message attributes. </para> </li> <li> <para> MD5 digest of the message attributes. </para> </li> </ul> <para> The receipt handle is the identifier you must provide when deleting the message. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html">Queue and Message Identifiers</a> in the <i>Amazon SQS Developer Guide</i>. </para> <para> You can provide the <code>VisibilityTimeout</code> parameter in your request, which will be applied to the messages that Amazon SQS returns in the response. If you do not include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. </para> <note> <para> Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. </para> </note> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <returns>The response from the ReceiveMessage service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.OverLimitException"> The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of messages inflight has already been reached. <a>AddPermission</a> returns this error if the maximum number of permissions for the queue has already been reached. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.ReceiveMessage(Amazon.SQS.Model.ReceiveMessageRequest)"> <summary> Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue. Long poll support is enabled by using the <code>WaitTimeSeconds</code> parameter. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html">Amazon SQS Long Poll</a> in the <i>Amazon SQS Developer Guide</i>. <para> Short poll is the default behavior where a weighted random set of machines is sampled on a <code>ReceiveMessage</code> call. This means only the messages on the sampled machines are returned. If the number of messages in the queue is small (less than 1000), it is likely you will get fewer messages than you requested per <code>ReceiveMessage</code> call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular <code>ReceiveMessage</code> response; in which case you should repeat the request. </para> <para> For each message returned, the response includes the following: </para> <ul> <li> <para> Message body </para> </li> <li> <para> MD5 digest of the message body. For information about MD5, go to <a href="http://www.faqs.org/rfcs/rfc1321.html">http://www.faqs.org/rfcs/rfc1321.html</a>. </para> </li> <li> <para> Message ID you received when you sent the message to the queue. </para> </li> <li> <para> Receipt handle. </para> </li> <li> <para> Message attributes. </para> </li> <li> <para> MD5 digest of the message attributes. </para> </li> </ul> <para> The receipt handle is the identifier you must provide when deleting the message. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html">Queue and Message Identifiers</a> in the <i>Amazon SQS Developer Guide</i>. </para> <para> You can provide the <code>VisibilityTimeout</code> parameter in your request, which will be applied to the messages that Amazon SQS returns in the response. If you do not include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. </para> <note> <para> Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ReceiveMessage service method.</param> <returns>The response from the ReceiveMessage service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.OverLimitException"> The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of messages inflight has already been reached. <a>AddPermission</a> returns this error if the maximum number of permissions for the queue has already been reached. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.ReceiveMessageAsync(Amazon.SQS.Model.ReceiveMessageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ReceiveMessage operation. </summary> <param name="request">Container for the necessary parameters to execute the ReceiveMessage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.RemovePermission(System.String,System.String)"> <summary> Revokes any permissions in the queue policy that matches the specified <code>Label</code> parameter. Only the owner of the queue can remove permissions. </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="label">The identification of the permission to remove. This is the label added with the <a>AddPermission</a> action.</param> <returns>The response from the RemovePermission service method, as returned by SQS.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.RemovePermission(Amazon.SQS.Model.RemovePermissionRequest)"> <summary> Revokes any permissions in the queue policy that matches the specified <code>Label</code> parameter. Only the owner of the queue can remove permissions. </summary> <param name="request">Container for the necessary parameters to execute the RemovePermission service method.</param> <returns>The response from the RemovePermission service method, as returned by SQS.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.RemovePermissionAsync(Amazon.SQS.Model.RemovePermissionRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemovePermission operation. </summary> <param name="request">Container for the necessary parameters to execute the RemovePermission operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.SendMessage(System.String,System.String)"> <summary> Delivers a message to the specified queue. With Amazon SQS, you now have the ability to send large payload messages that are up to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that supports SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK release notes. <important> <para> The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to <a href="http://www.w3.org/TR/REC-xml/#charsets">http://www.w3.org/TR/REC-xml/#charsets</a> If you send any characters not included in the list, your request will be rejected. </para> <para> #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF] </para> </important> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="messageBody">The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.</param> <returns>The response from the SendMessage service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.InvalidMessageContentsException"> The message contains characters outside the allowed set. </exception> <exception cref="T:Amazon.SQS.Model.UnsupportedOperationException"> Error code 400. Unsupported operation. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.SendMessage(Amazon.SQS.Model.SendMessageRequest)"> <summary> Delivers a message to the specified queue. With Amazon SQS, you now have the ability to send large payload messages that are up to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that supports SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK release notes. <important> <para> The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to <a href="http://www.w3.org/TR/REC-xml/#charsets">http://www.w3.org/TR/REC-xml/#charsets</a> If you send any characters not included in the list, your request will be rejected. </para> <para> #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF] </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the SendMessage service method.</param> <returns>The response from the SendMessage service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.InvalidMessageContentsException"> The message contains characters outside the allowed set. </exception> <exception cref="T:Amazon.SQS.Model.UnsupportedOperationException"> Error code 400. Unsupported operation. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.SendMessageAsync(Amazon.SQS.Model.SendMessageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SendMessage operation. </summary> <param name="request">Container for the necessary parameters to execute the SendMessage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.SendMessageBatch(System.String,System.Collections.Generic.List{Amazon.SQS.Model.SendMessageBatchRequestEntry})"> <summary> Delivers up to ten messages to the specified queue. This is a batch version of <a>SendMessage</a>. The result of the send action on each message is reported individually in the response. The maximum allowed individual message size is 256 KB (262,144 bytes). <para> The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes). </para> <para> If the <code>DelaySeconds</code> parameter is not specified for an entry, the default for the queue is used. </para> <important>The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification. For more information, go to <a href="http://www.faqs.org/rfcs/rfc1321.html">http://www.faqs.org/rfcs/rfc1321.html</a>. If you send any characters that are not included in the list, your request will be rejected. <para> #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF] </para> </important> <important> Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. </important> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="entries">A list of <a>SendMessageBatchRequestEntry</a> items.</param> <returns>The response from the SendMessageBatch service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.BatchEntryIdsNotDistinctException"> Two or more batch entries have the same <code>Id</code> in the request. </exception> <exception cref="T:Amazon.SQS.Model.BatchRequestTooLongException"> The length of all the messages put together is more than the limit. </exception> <exception cref="T:Amazon.SQS.Model.EmptyBatchRequestException"> Batch request does not contain an entry. </exception> <exception cref="T:Amazon.SQS.Model.InvalidBatchEntryIdException"> The <code>Id</code> of a batch entry in a batch request does not abide by the specification. </exception> <exception cref="T:Amazon.SQS.Model.TooManyEntriesInBatchRequestException"> Batch request contains more number of entries than permissible. </exception> <exception cref="T:Amazon.SQS.Model.UnsupportedOperationException"> Error code 400. Unsupported operation. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.SendMessageBatch(Amazon.SQS.Model.SendMessageBatchRequest)"> <summary> Delivers up to ten messages to the specified queue. This is a batch version of <a>SendMessage</a>. The result of the send action on each message is reported individually in the response. The maximum allowed individual message size is 256 KB (262,144 bytes). <para> The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes). </para> <para> If the <code>DelaySeconds</code> parameter is not specified for an entry, the default for the queue is used. </para> <important>The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification. For more information, go to <a href="http://www.faqs.org/rfcs/rfc1321.html">http://www.faqs.org/rfcs/rfc1321.html</a>. If you send any characters that are not included in the list, your request will be rejected. <para> #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF] </para> </important> <important> Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. </important> <note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note> <para> <code>&Attribute.1=this</code> </para> <para> <code>&Attribute.2=that</code> </para> </summary> <param name="request">Container for the necessary parameters to execute the SendMessageBatch service method.</param> <returns>The response from the SendMessageBatch service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.BatchEntryIdsNotDistinctException"> Two or more batch entries have the same <code>Id</code> in the request. </exception> <exception cref="T:Amazon.SQS.Model.BatchRequestTooLongException"> The length of all the messages put together is more than the limit. </exception> <exception cref="T:Amazon.SQS.Model.EmptyBatchRequestException"> Batch request does not contain an entry. </exception> <exception cref="T:Amazon.SQS.Model.InvalidBatchEntryIdException"> The <code>Id</code> of a batch entry in a batch request does not abide by the specification. </exception> <exception cref="T:Amazon.SQS.Model.TooManyEntriesInBatchRequestException"> Batch request contains more number of entries than permissible. </exception> <exception cref="T:Amazon.SQS.Model.UnsupportedOperationException"> Error code 400. Unsupported operation. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.SendMessageBatchAsync(Amazon.SQS.Model.SendMessageBatchRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SendMessageBatch operation. </summary> <param name="request">Container for the necessary parameters to execute the SendMessageBatch operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.SetQueueAttributes(System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the SQS system. Changes made to the <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes. <note>Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.</note> </summary> <param name="queueUrl">The URL of the Amazon SQS queue to take action on.</param> <param name="attributes">A map of attributes to set. The following lists the names, descriptions, and values of the special request parameters the <code>SetQueueAttributes</code> action uses: <ul> <li> <code>DelaySeconds</code> - The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero).</li> <li> <code>MaximumMessageSize</code> - The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).</li> <li> <code>MessageRetentionPeriod</code> - The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).</li> <li> <code>Policy</code> - The queue's policy. A valid AWS policy. For more information about policy structure, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>.</li> <li> <code>ReceiveMessageWaitTimeSeconds</code> - The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0. </li> <li> <code>VisibilityTimeout</code> - The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the <i>Amazon SQS Developer Guide</i>.</li> <li> <code>RedrivePolicy</code> - The parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the <i>Amazon SQS Developer Guide</i>.</li> </ul> </param> <returns>The response from the SetQueueAttributes service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.InvalidAttributeNameException"> The attribute referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.SetQueueAttributes(Amazon.SQS.Model.SetQueueAttributesRequest)"> <summary> Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the SQS system. Changes made to the <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes. <note>Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.</note> </summary> <param name="request">Container for the necessary parameters to execute the SetQueueAttributes service method.</param> <returns>The response from the SetQueueAttributes service method, as returned by SQS.</returns> <exception cref="T:Amazon.SQS.Model.InvalidAttributeNameException"> The attribute referred to does not exist. </exception> </member> <member name="M:Amazon.SQS.AmazonSQSClient.SetQueueAttributesAsync(Amazon.SQS.Model.SetQueueAttributesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the SetQueueAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the SetQueueAttributes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(System.String,System.String)"> <summary> This is a utility method which updates the policy of a queue to allow the S3 bucket to publish events to it. </summary> <param name="queueUrl">The queue that will have its policy updated.</param> <param name="bucket">The bucket that will be given access to send messages from.</param> <returns>The ARN for the SQS queue. This can be used when setting up the S3 bucket notification.</returns> </member> <member name="T:Amazon.StorageGateway.AmazonStorageGatewayClient"> <summary> Implementation for accessing StorageGateway AWS Storage Gateway Service <para> AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and AWS's storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery. </para> <para> Use the following links to get started using the <i>AWS Storage Gateway Service API Reference</i>: </para> <ul> <li><a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayHTTPRequestsHeaders.html">AWS Storage Gateway Required Request Headers</a>: Describes the required headers that you must send with every POST request to AWS Storage Gateway.</li> <li><a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewaySigningRequests.html">Signing Requests</a>: AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.</li> <li><a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/APIErrorResponses.html">Error Responses</a>: Provides reference information about AWS Storage Gateway errors.</li> <li><a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPIOperations.html">Operations in AWS Storage Gateway</a>: Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.</li> <li><a href="http://docs.aws.amazon.com/general/latest/gr/index.html?rande.html">AWS Storage Gateway Regions and Endpoints</a>: Provides a list of each of the regions and endpoints available for use with AWS Storage Gateway. </li> </ul> <note>AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-1122AABB. When you use this ID with the EC2 API, you must change it to vol-1122aabb. Otherwise, the EC2 API might not behave as expected.</note> </summary> </member> <member name="T:Amazon.StorageGateway.IAmazonStorageGateway"> <summary> Interface for accessing StorageGateway AWS Storage Gateway Service <para> AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and AWS's storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery. </para> <para> Use the following links to get started using the <i>AWS Storage Gateway Service API Reference</i>: </para> <ul> <li><a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayHTTPRequestsHeaders.html">AWS Storage Gateway Required Request Headers</a>: Describes the required headers that you must send with every POST request to AWS Storage Gateway.</li> <li><a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewaySigningRequests.html">Signing Requests</a>: AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.</li> <li><a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/APIErrorResponses.html">Error Responses</a>: Provides reference information about AWS Storage Gateway errors.</li> <li><a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPIOperations.html">Operations in AWS Storage Gateway</a>: Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.</li> <li><a href="http://docs.aws.amazon.com/general/latest/gr/index.html?rande.html">AWS Storage Gateway Regions and Endpoints</a>: Provides a list of each of the regions and endpoints available for use with AWS Storage Gateway. </li> </ul> <note>AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-1122AABB. When you use this ID with the EC2 API, you must change it to vol-1122aabb. Otherwise, the EC2 API might not behave as expected.</note> </summary> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ActivateGateway(Amazon.StorageGateway.Model.ActivateGatewayRequest)"> <summary> This operation activates the gateway you previously deployed on your host. For more information, see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/GettingStartedActivateGateway-common.html"> Activate the AWS Storage Gateway</a>. In the activation process, you specify information such as the region you want to use for storing snapshots, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see <a>UpdateGatewayInformation</a>. <note>You must turn on the gateway VM before you can activate your gateway.</note> </summary> <param name="request">Container for the necessary parameters to execute the ActivateGateway service method.</param> <returns>The response from the ActivateGateway service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ActivateGatewayAsync(Amazon.StorageGateway.Model.ActivateGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ActivateGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the ActivateGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.AddCache(Amazon.StorageGateway.Model.AddCacheRequest)"> <summary> This operation configures one or more gateway local disks as cache for a cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html">Storage Gateway Concepts</a>). <para> In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddCache service method.</param> <returns>The response from the AddCache service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.AddCacheAsync(Amazon.StorageGateway.Model.AddCacheRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddCache operation. </summary> <param name="request">Container for the necessary parameters to execute the AddCache operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.AddTagsToResource(Amazon.StorageGateway.Model.AddTagsToResourceRequest)"> <summary> This operation adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources: <ul> <li> <para> Storage gateways of all types </para> </li> </ul> <ul> <li> <para> Storage Volumes </para> </li> </ul> <ul> <li> <para> Virtual Tapes </para> </li> </ul> <para> You can create a maximum of 10 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToResource service method.</param> <returns>The response from the AddTagsToResource service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.AddTagsToResourceAsync(Amazon.StorageGateway.Model.AddTagsToResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTagsToResource operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.AddUploadBuffer(Amazon.StorageGateway.Model.AddUploadBufferRequest)"> <summary> This operation configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures. <para> In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddUploadBuffer service method.</param> <returns>The response from the AddUploadBuffer service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.AddUploadBufferAsync(Amazon.StorageGateway.Model.AddUploadBufferRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddUploadBuffer operation. </summary> <param name="request">Container for the necessary parameters to execute the AddUploadBuffer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.AddWorkingStorage(Amazon.StorageGateway.Model.AddWorkingStorageRequest)"> <summary> This operation configures one or more gateway local disks as working storage for a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated method in cached-volumes API version (20120630). Use AddUploadBuffer instead. <note> <para> Working storage is also referred to as upload buffer. You can also use the <a>AddUploadBuffer</a> operation to add upload buffer to a stored-volume gateway. </para> </note> <para> In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddWorkingStorage service method.</param> <returns>The response from the AddWorkingStorage service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.AddWorkingStorageAsync(Amazon.StorageGateway.Model.AddWorkingStorageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddWorkingStorage operation. </summary> <param name="request">Container for the necessary parameters to execute the AddWorkingStorage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.CancelArchival(Amazon.StorageGateway.Model.CancelArchivalRequest)"> <summary> Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. </summary> <param name="request">Container for the necessary parameters to execute the CancelArchival service method.</param> <returns>The response from the CancelArchival service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.CancelArchivalAsync(Amazon.StorageGateway.Model.CancelArchivalRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelArchival operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelArchival operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.CancelRetrieval(Amazon.StorageGateway.Model.CancelRetrievalRequest)"> <summary> Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. </summary> <param name="request">Container for the necessary parameters to execute the CancelRetrieval service method.</param> <returns>The response from the CancelRetrieval service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.CancelRetrievalAsync(Amazon.StorageGateway.Model.CancelRetrievalRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelRetrieval operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelRetrieval operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.CreateCachediSCSIVolume(Amazon.StorageGateway.Model.CreateCachediSCSIVolumeRequest)"> <summary> This operation creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture. <note>Cache storage must be allocated to the gateway before you can create a cached volume. Use the <a>AddCache</a> operation to add cache storage to a gateway. </note> <para> In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateCachediSCSIVolume service method.</param> <returns>The response from the CreateCachediSCSIVolume service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.CreateCachediSCSIVolumeAsync(Amazon.StorageGateway.Model.CreateCachediSCSIVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCachediSCSIVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCachediSCSIVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.CreateSnapshot(Amazon.StorageGateway.Model.CreateSnapshotRequest)"> <summary> This operation initiates a snapshot of a volume. <para> AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html">Working With Snapshots in the AWS Storage Gateway Console</a>. </para> <para> In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. </para> <note>To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Operations.html">EC2 API reference</a>.</note> </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot service method.</param> <returns>The response from the CreateSnapshot service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.CreateSnapshotAsync(Amazon.StorageGateway.Model.CreateSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.CreateSnapshotFromVolumeRecoveryPoint(Amazon.StorageGateway.Model.CreateSnapshotFromVolumeRecoveryPointRequest)"> <summary> This operation initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture (see ). <para> A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for gateway-cached volumes, use <a>ListVolumeRecoveryPoints</a>. </para> <para> In the <code>CreateSnapshotFromVolumeRecoveryPoint</code> request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. </para> <note> <para> To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in <i>Amazon Elastic Compute Cloud API Reference</i>. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshotFromVolumeRecoveryPoint service method.</param> <returns>The response from the CreateSnapshotFromVolumeRecoveryPoint service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.CreateSnapshotFromVolumeRecoveryPointAsync(Amazon.StorageGateway.Model.CreateSnapshotFromVolumeRecoveryPointRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSnapshotFromVolumeRecoveryPoint operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshotFromVolumeRecoveryPoint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.CreateStorediSCSIVolume(Amazon.StorageGateway.Model.CreateStorediSCSIVolumeRequest)"> <summary> This operation creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture. <para> The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased. </para> <para> In the request you must specify the gateway and the disk information on which you are creating the volume. In response, AWS Storage Gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateStorediSCSIVolume service method.</param> <returns>The response from the CreateStorediSCSIVolume service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.CreateStorediSCSIVolumeAsync(Amazon.StorageGateway.Model.CreateStorediSCSIVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateStorediSCSIVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateStorediSCSIVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.CreateTapes(Amazon.StorageGateway.Model.CreateTapesRequest)"> <summary> Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. <note>Cache storage must be allocated to the gateway before you can create virtual tapes. Use the <a>AddCache</a> operation to add cache storage to a gateway. </note> </summary> <param name="request">Container for the necessary parameters to execute the CreateTapes service method.</param> <returns>The response from the CreateTapes service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.CreateTapesAsync(Amazon.StorageGateway.Model.CreateTapesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTapes operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTapes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.CreateTapeWithBarcode(Amazon.StorageGateway.Model.CreateTapeWithBarcodeRequest)"> <summary> Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. <note>Cache storage must be allocated to the gateway before you can create a virtual tape. Use the <a>AddCache</a> operation to add cache storage to a gateway.</note> </summary> <param name="request">Container for the necessary parameters to execute the CreateTapeWithBarcode service method.</param> <returns>The response from the CreateTapeWithBarcode service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.CreateTapeWithBarcodeAsync(Amazon.StorageGateway.Model.CreateTapeWithBarcodeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTapeWithBarcode operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTapeWithBarcode operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DeleteBandwidthRateLimit(Amazon.StorageGateway.Model.DeleteBandwidthRateLimitRequest)"> <summary> This operation deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBandwidthRateLimit service method.</param> <returns>The response from the DeleteBandwidthRateLimit service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DeleteBandwidthRateLimitAsync(Amazon.StorageGateway.Model.DeleteBandwidthRateLimitRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteBandwidthRateLimit operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBandwidthRateLimit operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DeleteChapCredentials(Amazon.StorageGateway.Model.DeleteChapCredentialsRequest)"> <summary> This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. </summary> <param name="request">Container for the necessary parameters to execute the DeleteChapCredentials service method.</param> <returns>The response from the DeleteChapCredentials service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DeleteChapCredentialsAsync(Amazon.StorageGateway.Model.DeleteChapCredentialsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteChapCredentials operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteChapCredentials operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DeleteGateway(Amazon.StorageGateway.Model.DeleteGatewayRequest)"> <summary> This operation deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer. <para> After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment. </para> <important> <para> You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the <a href="http://aws.amazon.com/storagegateway"> AWS Storage Gateway Detail Page</a>. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteGateway service method.</param> <returns>The response from the DeleteGateway service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DeleteGatewayAsync(Amazon.StorageGateway.Model.DeleteGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DeleteSnapshotSchedule(Amazon.StorageGateway.Model.DeleteSnapshotScheduleRequest)"> <summary> This operation deletes a snapshot of a volume. <para> You can take snapshots of your gateway volumes on a scheduled or ad-hoc basis. This API enables you to delete a snapshot schedule for a volume. For more information, see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html">Working with Snapshots</a>. In the <code>DeleteSnapshotSchedule</code> request, you identify the volume by providing its Amazon Resource Name (ARN). </para> <note> <para> To list or delete a snapshot, you must use the Amazon EC2 API. in <i>Amazon Elastic Compute Cloud API Reference</i>. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshotSchedule service method.</param> <returns>The response from the DeleteSnapshotSchedule service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DeleteSnapshotScheduleAsync(Amazon.StorageGateway.Model.DeleteSnapshotScheduleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSnapshotSchedule operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshotSchedule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DeleteTape(Amazon.StorageGateway.Model.DeleteTapeRequest)"> <summary> Deletes the specified virtual tape. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTape service method.</param> <returns>The response from the DeleteTape service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DeleteTapeAsync(Amazon.StorageGateway.Model.DeleteTapeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTape operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTape operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DeleteTapeArchive(Amazon.StorageGateway.Model.DeleteTapeArchiveRequest)"> <summary> Deletes the specified virtual tape from the virtual tape shelf (VTS). </summary> <param name="request">Container for the necessary parameters to execute the DeleteTapeArchive service method.</param> <returns>The response from the DeleteTapeArchive service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DeleteTapeArchiveAsync(Amazon.StorageGateway.Model.DeleteTapeArchiveRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTapeArchive operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTapeArchive operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DeleteVolume(Amazon.StorageGateway.Model.DeleteVolumeRequest)"> <summary> This operation deletes the specified gateway volume that you previously created using the <a>CreateCachediSCSIVolume</a> or <a>CreateStorediSCSIVolume</a> API. For gateway-stored volumes, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume. <para> Before you delete a gateway volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API Reference</i>. </para> <para> In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVolume service method.</param> <returns>The response from the DeleteVolume service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DeleteVolumeAsync(Amazon.StorageGateway.Model.DeleteVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeBandwidthRateLimit(Amazon.StorageGateway.Model.DescribeBandwidthRateLimitRequest)"> <summary> This operation returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. <para> This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeBandwidthRateLimit service method.</param> <returns>The response from the DescribeBandwidthRateLimit service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeBandwidthRateLimitAsync(Amazon.StorageGateway.Model.DescribeBandwidthRateLimitRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeBandwidthRateLimit operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeBandwidthRateLimit operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeCache(Amazon.StorageGateway.Model.DescribeCacheRequest)"> <summary> This operation returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture. <para> The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCache service method.</param> <returns>The response from the DescribeCache service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeCacheAsync(Amazon.StorageGateway.Model.DescribeCacheRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCache operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCache operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeCachediSCSIVolumes(Amazon.StorageGateway.Model.DescribeCachediSCSIVolumesRequest)"> <summary> This operation returns a description of the gateway volumes specified in the request. This operation is supported only for the gateway-cached volume architecture. <para> The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN). </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCachediSCSIVolumes service method.</param> <returns>The response from the DescribeCachediSCSIVolumes service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeCachediSCSIVolumesAsync(Amazon.StorageGateway.Model.DescribeCachediSCSIVolumesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCachediSCSIVolumes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCachediSCSIVolumes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeChapCredentials(Amazon.StorageGateway.Model.DescribeChapCredentialsRequest)"> <summary> This operation returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. </summary> <param name="request">Container for the necessary parameters to execute the DescribeChapCredentials service method.</param> <returns>The response from the DescribeChapCredentials service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeChapCredentialsAsync(Amazon.StorageGateway.Model.DescribeChapCredentialsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeChapCredentials operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeChapCredentials operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeGatewayInformation(Amazon.StorageGateway.Model.DescribeGatewayInformationRequest)"> <summary> This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. </summary> <param name="request">Container for the necessary parameters to execute the DescribeGatewayInformation service method.</param> <returns>The response from the DescribeGatewayInformation service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeGatewayInformationAsync(Amazon.StorageGateway.Model.DescribeGatewayInformationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeGatewayInformation operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeGatewayInformation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeMaintenanceStartTime(Amazon.StorageGateway.Model.DescribeMaintenanceStartTimeRequest)"> <summary> This operation returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMaintenanceStartTime service method.</param> <returns>The response from the DescribeMaintenanceStartTime service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeMaintenanceStartTimeAsync(Amazon.StorageGateway.Model.DescribeMaintenanceStartTimeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeMaintenanceStartTime operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMaintenanceStartTime operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeSnapshotSchedule(Amazon.StorageGateway.Model.DescribeSnapshotScheduleRequest)"> <summary> This operation describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshotSchedule service method.</param> <returns>The response from the DescribeSnapshotSchedule service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeSnapshotScheduleAsync(Amazon.StorageGateway.Model.DescribeSnapshotScheduleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSnapshotSchedule operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshotSchedule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeStorediSCSIVolumes(Amazon.StorageGateway.Model.DescribeStorediSCSIVolumesRequest)"> <summary> This operation returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStorediSCSIVolumes service method.</param> <returns>The response from the DescribeStorediSCSIVolumes service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeStorediSCSIVolumesAsync(Amazon.StorageGateway.Model.DescribeStorediSCSIVolumesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStorediSCSIVolumes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStorediSCSIVolumes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeTapeArchives"> <summary> Returns a description of specified virtual tapes in the virtual tape shelf (VTS). <para> If a specific <code>TapeARN</code> is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account. </para> </summary> <returns>The response from the DescribeTapeArchives service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeTapeArchives(Amazon.StorageGateway.Model.DescribeTapeArchivesRequest)"> <summary> Returns a description of specified virtual tapes in the virtual tape shelf (VTS). <para> If a specific <code>TapeARN</code> is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTapeArchives service method.</param> <returns>The response from the DescribeTapeArchives service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeTapeArchivesAsync(Amazon.StorageGateway.Model.DescribeTapeArchivesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTapeArchives operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTapeArchives operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeTapeRecoveryPoints(Amazon.StorageGateway.Model.DescribeTapeRecoveryPointsRequest)"> <summary> Returns a list of virtual tape recovery points that are available for the specified gateway-VTL. <para> A recovery point is a point in time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTapeRecoveryPoints service method.</param> <returns>The response from the DescribeTapeRecoveryPoints service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeTapeRecoveryPointsAsync(Amazon.StorageGateway.Model.DescribeTapeRecoveryPointsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTapeRecoveryPoints operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTapeRecoveryPoints operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeTapes(Amazon.StorageGateway.Model.DescribeTapesRequest)"> <summary> Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a <code>TapeARN</code> is not specified, returns a description of all virtual tapes associated with the specified gateway. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTapes service method.</param> <returns>The response from the DescribeTapes service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeTapesAsync(Amazon.StorageGateway.Model.DescribeTapesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTapes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTapes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeUploadBuffer(Amazon.StorageGateway.Model.DescribeUploadBufferRequest)"> <summary> This operation returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures. <para> The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeUploadBuffer service method.</param> <returns>The response from the DescribeUploadBuffer service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeUploadBufferAsync(Amazon.StorageGateway.Model.DescribeUploadBufferRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeUploadBuffer operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeUploadBuffer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeVTLDevices(Amazon.StorageGateway.Model.DescribeVTLDevicesRequest)"> <summary> Returns a description of virtual tape library (VTL) devices for the specified gateway. In the response, AWS Storage Gateway returns VTL device information. <para> The list of VTL devices must be from one gateway. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVTLDevices service method.</param> <returns>The response from the DescribeVTLDevices service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeVTLDevicesAsync(Amazon.StorageGateway.Model.DescribeVTLDevicesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVTLDevices operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVTLDevices operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeWorkingStorage(Amazon.StorageGateway.Model.DescribeWorkingStorageRequest)"> <summary> This operation returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead. <note> <para> Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored-volume gateway. </para> </note> <para> The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkingStorage service method.</param> <returns>The response from the DescribeWorkingStorage service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DescribeWorkingStorageAsync(Amazon.StorageGateway.Model.DescribeWorkingStorageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeWorkingStorage operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkingStorage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DisableGateway(Amazon.StorageGateway.Model.DisableGatewayRequest)"> <summary> Disables a gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes. <para> Use this operation for a gateway-VTL that is not reachable or not functioning. </para> <important>Once a gateway is disabled it cannot be enabled.</important> </summary> <param name="request">Container for the necessary parameters to execute the DisableGateway service method.</param> <returns>The response from the DisableGateway service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.DisableGatewayAsync(Amazon.StorageGateway.Model.DisableGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ListGateways"> <summary> This operation lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN). <para> By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response. </para> <para> If you have more gateways than are returned in a response-that is, the response returns only a truncated list of your gateways-the response contains a marker that you can specify in your next request to fetch the next page of gateways. </para> </summary> <returns>The response from the ListGateways service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ListGateways(Amazon.StorageGateway.Model.ListGatewaysRequest)"> <summary> This operation lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN). <para> By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response. </para> <para> If you have more gateways than are returned in a response-that is, the response returns only a truncated list of your gateways-the response contains a marker that you can specify in your next request to fetch the next page of gateways. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListGateways service method.</param> <returns>The response from the ListGateways service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ListGatewaysAsync(Amazon.StorageGateway.Model.ListGatewaysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the ListGateways operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ListLocalDisks(Amazon.StorageGateway.Model.ListLocalDisksRequest)"> <summary> This operation returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request. <para> The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a <code>DiskStatus</code> field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted). </para> </summary> <param name="request">Container for the necessary parameters to execute the ListLocalDisks service method.</param> <returns>The response from the ListLocalDisks service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ListLocalDisksAsync(Amazon.StorageGateway.Model.ListLocalDisksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListLocalDisks operation. </summary> <param name="request">Container for the necessary parameters to execute the ListLocalDisks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ListTagsForResource(Amazon.StorageGateway.Model.ListTagsForResourceRequest)"> <summary> This operation lists the tags that have been added to the specified resource. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResource service method.</param> <returns>The response from the ListTagsForResource service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ListTagsForResourceAsync(Amazon.StorageGateway.Model.ListTagsForResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTagsForResource operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ListVolumeInitiators(Amazon.StorageGateway.Model.ListVolumeInitiatorsRequest)"> <summary> This operation lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. </summary> <param name="request">Container for the necessary parameters to execute the ListVolumeInitiators service method.</param> <returns>The response from the ListVolumeInitiators service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ListVolumeInitiatorsAsync(Amazon.StorageGateway.Model.ListVolumeInitiatorsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListVolumeInitiators operation. </summary> <param name="request">Container for the necessary parameters to execute the ListVolumeInitiators operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ListVolumeRecoveryPoints(Amazon.StorageGateway.Model.ListVolumeRecoveryPointsRequest)"> <summary> This operation lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture. <para> Each gateway-cached volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To create a snapshot from a volume recovery point use the <a>CreateSnapshotFromVolumeRecoveryPoint</a> operation. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListVolumeRecoveryPoints service method.</param> <returns>The response from the ListVolumeRecoveryPoints service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ListVolumeRecoveryPointsAsync(Amazon.StorageGateway.Model.ListVolumeRecoveryPointsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListVolumeRecoveryPoints operation. </summary> <param name="request">Container for the necessary parameters to execute the ListVolumeRecoveryPoints operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ListVolumes(Amazon.StorageGateway.Model.ListVolumesRequest)"> <summary> This operation lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the <a>DescribeStorediSCSIVolumes</a> API. <para> The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the <code>Limit</code> field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListVolumes service method.</param> <returns>The response from the ListVolumes service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ListVolumesAsync(Amazon.StorageGateway.Model.ListVolumesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListVolumes operation. </summary> <param name="request">Container for the necessary parameters to execute the ListVolumes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.RemoveTagsFromResource(Amazon.StorageGateway.Model.RemoveTagsFromResourceRequest)"> <summary> This operation removes one or more tags from the specified resource. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromResource service method.</param> <returns>The response from the RemoveTagsFromResource service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.RemoveTagsFromResourceAsync(Amazon.StorageGateway.Model.RemoveTagsFromResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTagsFromResource operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ResetCache(System.String)"> <summary> This operation resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. <important> <para> If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly. </para> </important> </summary> <param name="gatewayARN">A property of ResetCacheRequest used to execute the ResetCache service method.</param> <returns>The response from the ResetCache service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ResetCache(Amazon.StorageGateway.Model.ResetCacheRequest)"> <summary> This operation resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. <important> <para> If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the ResetCache service method.</param> <returns>The response from the ResetCache service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ResetCacheAsync(Amazon.StorageGateway.Model.ResetCacheRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetCache operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetCache operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.RetrieveTapeArchive(Amazon.StorageGateway.Model.RetrieveTapeArchiveRequest)"> <summary> Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS. <para> Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. </para> </summary> <param name="request">Container for the necessary parameters to execute the RetrieveTapeArchive service method.</param> <returns>The response from the RetrieveTapeArchive service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.RetrieveTapeArchiveAsync(Amazon.StorageGateway.Model.RetrieveTapeArchiveRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RetrieveTapeArchive operation. </summary> <param name="request">Container for the necessary parameters to execute the RetrieveTapeArchive operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.RetrieveTapeRecoveryPoint(Amazon.StorageGateway.Model.RetrieveTapeRecoveryPointRequest)"> <summary> Retrieves the recovery point for the specified virtual tape. <para> A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. </para> <note>The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a gateway-VTL. There is no charge for retrieving recovery points.</note> </summary> <param name="request">Container for the necessary parameters to execute the RetrieveTapeRecoveryPoint service method.</param> <returns>The response from the RetrieveTapeRecoveryPoint service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.RetrieveTapeRecoveryPointAsync(Amazon.StorageGateway.Model.RetrieveTapeRecoveryPointRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RetrieveTapeRecoveryPoint operation. </summary> <param name="request">Container for the necessary parameters to execute the RetrieveTapeRecoveryPoint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ShutdownGateway(Amazon.StorageGateway.Model.ShutdownGatewayRequest)"> <summary> This operation shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request. <para> The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM. </para> <note>If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.</note> <para> After the gateway is shutdown, you cannot call any other API except <a>StartGateway</a>, <a>DescribeGatewayInformation</a>, and <a>ListGateways</a>. For more information, see <a>ActivateGateway</a>. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken. </para> <note>When you make a shutdown request, you will get a <code>200 OK</code> success response immediately. However, it might take some time for the gateway to shut down. You can call the <a>DescribeGatewayInformation</a> API to check the status. For more information, see <a>ActivateGateway</a>.</note> <para> If do not intend to use the gateway again, you must delete the gateway (using <a>DeleteGateway</a>) to no longer pay software charges associated with the gateway. </para> </summary> <param name="request">Container for the necessary parameters to execute the ShutdownGateway service method.</param> <returns>The response from the ShutdownGateway service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.ShutdownGatewayAsync(Amazon.StorageGateway.Model.ShutdownGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ShutdownGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the ShutdownGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.StartGateway(Amazon.StorageGateway.Model.StartGatewayRequest)"> <summary> This operation starts a gateway that you previously shut down (see <a>ShutdownGateway</a>). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups. <note>When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call <a>DescribeGatewayInformation</a> and check the status before making any additional API calls. For more information, see <a>ActivateGateway</a>.</note> <para> To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </summary> <param name="request">Container for the necessary parameters to execute the StartGateway service method.</param> <returns>The response from the StartGateway service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.StartGatewayAsync(Amazon.StorageGateway.Model.StartGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the StartGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.UpdateBandwidthRateLimit(Amazon.StorageGateway.Model.UpdateBandwidthRateLimitRequest)"> <summary> This operation updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. <para> By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth. </para> <para> To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateBandwidthRateLimit service method.</param> <returns>The response from the UpdateBandwidthRateLimit service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.UpdateBandwidthRateLimitAsync(Amazon.StorageGateway.Model.UpdateBandwidthRateLimitRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateBandwidthRateLimit operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateBandwidthRateLimit operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.UpdateChapCredentials(Amazon.StorageGateway.Model.UpdateChapCredentialsRequest)"> <summary> This operation updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. <important> <para> When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the UpdateChapCredentials service method.</param> <returns>The response from the UpdateChapCredentials service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.UpdateChapCredentialsAsync(Amazon.StorageGateway.Model.UpdateChapCredentialsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateChapCredentials operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateChapCredentials operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.UpdateGatewayInformation(Amazon.StorageGateway.Model.UpdateGatewayInformationRequest)"> <summary> This operation updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. <note>For Gateways activated after September 02, 2015, the gateway's ARN contains the gateway id rather than the gateway name. However changing the name of the gateway has no effect on the gateway's ARN.</note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateGatewayInformation service method.</param> <returns>The response from the UpdateGatewayInformation service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.UpdateGatewayInformationAsync(Amazon.StorageGateway.Model.UpdateGatewayInformationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateGatewayInformation operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateGatewayInformation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.UpdateGatewaySoftwareNow(Amazon.StorageGateway.Model.UpdateGatewaySoftwareNowRequest)"> <summary> This operation updates the gateway virtual machine (VM) software. The request immediately triggers the software update. <note>When you make this request, you get a <code>200 OK</code> success response immediately. However, it might take some time for the update to complete. You can call <a>DescribeGatewayInformation</a> to verify the gateway is in the <code>STATE_RUNNING</code> state.</note> <important>A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings">Customizing Your Windows iSCSI Settings</a> and <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings">Customizing Your Linux iSCSI Settings</a>, respectively.</important> </summary> <param name="request">Container for the necessary parameters to execute the UpdateGatewaySoftwareNow service method.</param> <returns>The response from the UpdateGatewaySoftwareNow service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.UpdateGatewaySoftwareNowAsync(Amazon.StorageGateway.Model.UpdateGatewaySoftwareNowRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateGatewaySoftwareNow operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateGatewaySoftwareNow operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.UpdateMaintenanceStartTime(Amazon.StorageGateway.Model.UpdateMaintenanceStartTimeRequest)"> <summary> This operation updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. </summary> <param name="request">Container for the necessary parameters to execute the UpdateMaintenanceStartTime service method.</param> <returns>The response from the UpdateMaintenanceStartTime service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.UpdateMaintenanceStartTimeAsync(Amazon.StorageGateway.Model.UpdateMaintenanceStartTimeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateMaintenanceStartTime operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateMaintenanceStartTime operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.UpdateSnapshotSchedule(Amazon.StorageGateway.Model.UpdateSnapshotScheduleRequest)"> <summary> This operation updates a snapshot schedule configured for a gateway volume. <para> The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume. </para> <para> In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateSnapshotSchedule service method.</param> <returns>The response from the UpdateSnapshotSchedule service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.UpdateSnapshotScheduleAsync(Amazon.StorageGateway.Model.UpdateSnapshotScheduleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateSnapshotSchedule operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateSnapshotSchedule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.UpdateVTLDeviceType(Amazon.StorageGateway.Model.UpdateVTLDeviceTypeRequest)"> <summary> This operation updates the type of medium changer in a gateway-VTL. When you activate a gateway-VTL, you select a medium changer type for the gateway-VTL. This operation enables you to select a different type of medium changer after a gateway-VTL is activated. </summary> <param name="request">Container for the necessary parameters to execute the UpdateVTLDeviceType service method.</param> <returns>The response from the UpdateVTLDeviceType service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.IAmazonStorageGateway.UpdateVTLDeviceTypeAsync(Amazon.StorageGateway.Model.UpdateVTLDeviceTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateVTLDeviceType operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateVTLDeviceType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.#ctor"> <summary> Constructs AmazonStorageGatewayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonStorageGatewayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.#ctor(Amazon.StorageGateway.AmazonStorageGatewayConfig)"> <summary> Constructs AmazonStorageGatewayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonStorageGatewayClient Configuration Object</param> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonStorageGatewayClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonStorageGatewayClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.StorageGateway.AmazonStorageGatewayConfig)"> <summary> Constructs AmazonStorageGatewayClient with AWS Credentials and an AmazonStorageGatewayClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonStorageGatewayClient Configuration Object</param> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonStorageGatewayClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonStorageGatewayClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.#ctor(System.String,System.String,Amazon.StorageGateway.AmazonStorageGatewayConfig)"> <summary> Constructs AmazonStorageGatewayClient with AWS Access Key ID, AWS Secret Key and an AmazonStorageGatewayClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonStorageGatewayClient Configuration Object</param> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonStorageGatewayClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonStorageGatewayClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.#ctor(System.String,System.String,System.String,Amazon.StorageGateway.AmazonStorageGatewayConfig)"> <summary> Constructs AmazonStorageGatewayClient with AWS Access Key ID, AWS Secret Key and an AmazonStorageGatewayClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonStorageGatewayClient Configuration Object</param> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ActivateGateway(Amazon.StorageGateway.Model.ActivateGatewayRequest)"> <summary> This operation activates the gateway you previously deployed on your host. For more information, see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/GettingStartedActivateGateway-common.html"> Activate the AWS Storage Gateway</a>. In the activation process, you specify information such as the region you want to use for storing snapshots, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see <a>UpdateGatewayInformation</a>. <note>You must turn on the gateway VM before you can activate your gateway.</note> </summary> <param name="request">Container for the necessary parameters to execute the ActivateGateway service method.</param> <returns>The response from the ActivateGateway service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ActivateGatewayAsync(Amazon.StorageGateway.Model.ActivateGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ActivateGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the ActivateGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.AddCache(Amazon.StorageGateway.Model.AddCacheRequest)"> <summary> This operation configures one or more gateway local disks as cache for a cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html">Storage Gateway Concepts</a>). <para> In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddCache service method.</param> <returns>The response from the AddCache service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.AddCacheAsync(Amazon.StorageGateway.Model.AddCacheRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddCache operation. </summary> <param name="request">Container for the necessary parameters to execute the AddCache operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.AddTagsToResource(Amazon.StorageGateway.Model.AddTagsToResourceRequest)"> <summary> This operation adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources: <ul> <li> <para> Storage gateways of all types </para> </li> </ul> <ul> <li> <para> Storage Volumes </para> </li> </ul> <ul> <li> <para> Virtual Tapes </para> </li> </ul> <para> You can create a maximum of 10 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToResource service method.</param> <returns>The response from the AddTagsToResource service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.AddTagsToResourceAsync(Amazon.StorageGateway.Model.AddTagsToResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddTagsToResource operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.AddUploadBuffer(Amazon.StorageGateway.Model.AddUploadBufferRequest)"> <summary> This operation configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures. <para> In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddUploadBuffer service method.</param> <returns>The response from the AddUploadBuffer service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.AddUploadBufferAsync(Amazon.StorageGateway.Model.AddUploadBufferRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddUploadBuffer operation. </summary> <param name="request">Container for the necessary parameters to execute the AddUploadBuffer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.AddWorkingStorage(Amazon.StorageGateway.Model.AddWorkingStorageRequest)"> <summary> This operation configures one or more gateway local disks as working storage for a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated method in cached-volumes API version (20120630). Use AddUploadBuffer instead. <note> <para> Working storage is also referred to as upload buffer. You can also use the <a>AddUploadBuffer</a> operation to add upload buffer to a stored-volume gateway. </para> </note> <para> In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddWorkingStorage service method.</param> <returns>The response from the AddWorkingStorage service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.AddWorkingStorageAsync(Amazon.StorageGateway.Model.AddWorkingStorageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AddWorkingStorage operation. </summary> <param name="request">Container for the necessary parameters to execute the AddWorkingStorage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.CancelArchival(Amazon.StorageGateway.Model.CancelArchivalRequest)"> <summary> Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. </summary> <param name="request">Container for the necessary parameters to execute the CancelArchival service method.</param> <returns>The response from the CancelArchival service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.CancelArchivalAsync(Amazon.StorageGateway.Model.CancelArchivalRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelArchival operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelArchival operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.CancelRetrieval(Amazon.StorageGateway.Model.CancelRetrievalRequest)"> <summary> Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. </summary> <param name="request">Container for the necessary parameters to execute the CancelRetrieval service method.</param> <returns>The response from the CancelRetrieval service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.CancelRetrievalAsync(Amazon.StorageGateway.Model.CancelRetrievalRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CancelRetrieval operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelRetrieval operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.CreateCachediSCSIVolume(Amazon.StorageGateway.Model.CreateCachediSCSIVolumeRequest)"> <summary> This operation creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture. <note>Cache storage must be allocated to the gateway before you can create a cached volume. Use the <a>AddCache</a> operation to add cache storage to a gateway. </note> <para> In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateCachediSCSIVolume service method.</param> <returns>The response from the CreateCachediSCSIVolume service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.CreateCachediSCSIVolumeAsync(Amazon.StorageGateway.Model.CreateCachediSCSIVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateCachediSCSIVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCachediSCSIVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.CreateSnapshot(Amazon.StorageGateway.Model.CreateSnapshotRequest)"> <summary> This operation initiates a snapshot of a volume. <para> AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html">Working With Snapshots in the AWS Storage Gateway Console</a>. </para> <para> In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. </para> <note>To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Operations.html">EC2 API reference</a>.</note> </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot service method.</param> <returns>The response from the CreateSnapshot service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.CreateSnapshotAsync(Amazon.StorageGateway.Model.CreateSnapshotRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.CreateSnapshotFromVolumeRecoveryPoint(Amazon.StorageGateway.Model.CreateSnapshotFromVolumeRecoveryPointRequest)"> <summary> This operation initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture (see ). <para> A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for gateway-cached volumes, use <a>ListVolumeRecoveryPoints</a>. </para> <para> In the <code>CreateSnapshotFromVolumeRecoveryPoint</code> request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. </para> <note> <para> To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in <i>Amazon Elastic Compute Cloud API Reference</i>. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshotFromVolumeRecoveryPoint service method.</param> <returns>The response from the CreateSnapshotFromVolumeRecoveryPoint service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.CreateSnapshotFromVolumeRecoveryPointAsync(Amazon.StorageGateway.Model.CreateSnapshotFromVolumeRecoveryPointRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateSnapshotFromVolumeRecoveryPoint operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshotFromVolumeRecoveryPoint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.CreateStorediSCSIVolume(Amazon.StorageGateway.Model.CreateStorediSCSIVolumeRequest)"> <summary> This operation creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture. <para> The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased. </para> <para> In the request you must specify the gateway and the disk information on which you are creating the volume. In response, AWS Storage Gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateStorediSCSIVolume service method.</param> <returns>The response from the CreateStorediSCSIVolume service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.CreateStorediSCSIVolumeAsync(Amazon.StorageGateway.Model.CreateStorediSCSIVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateStorediSCSIVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateStorediSCSIVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.CreateTapes(Amazon.StorageGateway.Model.CreateTapesRequest)"> <summary> Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. <note>Cache storage must be allocated to the gateway before you can create virtual tapes. Use the <a>AddCache</a> operation to add cache storage to a gateway. </note> </summary> <param name="request">Container for the necessary parameters to execute the CreateTapes service method.</param> <returns>The response from the CreateTapes service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.CreateTapesAsync(Amazon.StorageGateway.Model.CreateTapesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTapes operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTapes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.CreateTapeWithBarcode(Amazon.StorageGateway.Model.CreateTapeWithBarcodeRequest)"> <summary> Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. <note>Cache storage must be allocated to the gateway before you can create a virtual tape. Use the <a>AddCache</a> operation to add cache storage to a gateway.</note> </summary> <param name="request">Container for the necessary parameters to execute the CreateTapeWithBarcode service method.</param> <returns>The response from the CreateTapeWithBarcode service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.CreateTapeWithBarcodeAsync(Amazon.StorageGateway.Model.CreateTapeWithBarcodeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateTapeWithBarcode operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTapeWithBarcode operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DeleteBandwidthRateLimit(Amazon.StorageGateway.Model.DeleteBandwidthRateLimitRequest)"> <summary> This operation deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBandwidthRateLimit service method.</param> <returns>The response from the DeleteBandwidthRateLimit service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DeleteBandwidthRateLimitAsync(Amazon.StorageGateway.Model.DeleteBandwidthRateLimitRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteBandwidthRateLimit operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteBandwidthRateLimit operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DeleteChapCredentials(Amazon.StorageGateway.Model.DeleteChapCredentialsRequest)"> <summary> This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. </summary> <param name="request">Container for the necessary parameters to execute the DeleteChapCredentials service method.</param> <returns>The response from the DeleteChapCredentials service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DeleteChapCredentialsAsync(Amazon.StorageGateway.Model.DeleteChapCredentialsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteChapCredentials operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteChapCredentials operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DeleteGateway(Amazon.StorageGateway.Model.DeleteGatewayRequest)"> <summary> This operation deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer. <para> After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment. </para> <important> <para> You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the <a href="http://aws.amazon.com/storagegateway"> AWS Storage Gateway Detail Page</a>. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteGateway service method.</param> <returns>The response from the DeleteGateway service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DeleteGatewayAsync(Amazon.StorageGateway.Model.DeleteGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DeleteSnapshotSchedule(Amazon.StorageGateway.Model.DeleteSnapshotScheduleRequest)"> <summary> This operation deletes a snapshot of a volume. <para> You can take snapshots of your gateway volumes on a scheduled or ad-hoc basis. This API enables you to delete a snapshot schedule for a volume. For more information, see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html">Working with Snapshots</a>. In the <code>DeleteSnapshotSchedule</code> request, you identify the volume by providing its Amazon Resource Name (ARN). </para> <note> <para> To list or delete a snapshot, you must use the Amazon EC2 API. in <i>Amazon Elastic Compute Cloud API Reference</i>. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshotSchedule service method.</param> <returns>The response from the DeleteSnapshotSchedule service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DeleteSnapshotScheduleAsync(Amazon.StorageGateway.Model.DeleteSnapshotScheduleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteSnapshotSchedule operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshotSchedule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DeleteTape(Amazon.StorageGateway.Model.DeleteTapeRequest)"> <summary> Deletes the specified virtual tape. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTape service method.</param> <returns>The response from the DeleteTape service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DeleteTapeAsync(Amazon.StorageGateway.Model.DeleteTapeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTape operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTape operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DeleteTapeArchive(Amazon.StorageGateway.Model.DeleteTapeArchiveRequest)"> <summary> Deletes the specified virtual tape from the virtual tape shelf (VTS). </summary> <param name="request">Container for the necessary parameters to execute the DeleteTapeArchive service method.</param> <returns>The response from the DeleteTapeArchive service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DeleteTapeArchiveAsync(Amazon.StorageGateway.Model.DeleteTapeArchiveRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteTapeArchive operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTapeArchive operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DeleteVolume(Amazon.StorageGateway.Model.DeleteVolumeRequest)"> <summary> This operation deletes the specified gateway volume that you previously created using the <a>CreateCachediSCSIVolume</a> or <a>CreateStorediSCSIVolume</a> API. For gateway-stored volumes, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume. <para> Before you delete a gateway volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API Reference</i>. </para> <para> In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVolume service method.</param> <returns>The response from the DeleteVolume service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DeleteVolumeAsync(Amazon.StorageGateway.Model.DeleteVolumeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DeleteVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVolume operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeBandwidthRateLimit(Amazon.StorageGateway.Model.DescribeBandwidthRateLimitRequest)"> <summary> This operation returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. <para> This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeBandwidthRateLimit service method.</param> <returns>The response from the DescribeBandwidthRateLimit service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeBandwidthRateLimitAsync(Amazon.StorageGateway.Model.DescribeBandwidthRateLimitRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeBandwidthRateLimit operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeBandwidthRateLimit operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeCache(Amazon.StorageGateway.Model.DescribeCacheRequest)"> <summary> This operation returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture. <para> The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCache service method.</param> <returns>The response from the DescribeCache service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeCacheAsync(Amazon.StorageGateway.Model.DescribeCacheRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCache operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCache operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeCachediSCSIVolumes(Amazon.StorageGateway.Model.DescribeCachediSCSIVolumesRequest)"> <summary> This operation returns a description of the gateway volumes specified in the request. This operation is supported only for the gateway-cached volume architecture. <para> The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN). </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCachediSCSIVolumes service method.</param> <returns>The response from the DescribeCachediSCSIVolumes service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeCachediSCSIVolumesAsync(Amazon.StorageGateway.Model.DescribeCachediSCSIVolumesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeCachediSCSIVolumes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCachediSCSIVolumes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeChapCredentials(Amazon.StorageGateway.Model.DescribeChapCredentialsRequest)"> <summary> This operation returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. </summary> <param name="request">Container for the necessary parameters to execute the DescribeChapCredentials service method.</param> <returns>The response from the DescribeChapCredentials service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeChapCredentialsAsync(Amazon.StorageGateway.Model.DescribeChapCredentialsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeChapCredentials operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeChapCredentials operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeGatewayInformation(Amazon.StorageGateway.Model.DescribeGatewayInformationRequest)"> <summary> This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. </summary> <param name="request">Container for the necessary parameters to execute the DescribeGatewayInformation service method.</param> <returns>The response from the DescribeGatewayInformation service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeGatewayInformationAsync(Amazon.StorageGateway.Model.DescribeGatewayInformationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeGatewayInformation operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeGatewayInformation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeMaintenanceStartTime(Amazon.StorageGateway.Model.DescribeMaintenanceStartTimeRequest)"> <summary> This operation returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMaintenanceStartTime service method.</param> <returns>The response from the DescribeMaintenanceStartTime service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeMaintenanceStartTimeAsync(Amazon.StorageGateway.Model.DescribeMaintenanceStartTimeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeMaintenanceStartTime operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMaintenanceStartTime operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeSnapshotSchedule(Amazon.StorageGateway.Model.DescribeSnapshotScheduleRequest)"> <summary> This operation describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshotSchedule service method.</param> <returns>The response from the DescribeSnapshotSchedule service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeSnapshotScheduleAsync(Amazon.StorageGateway.Model.DescribeSnapshotScheduleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeSnapshotSchedule operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshotSchedule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeStorediSCSIVolumes(Amazon.StorageGateway.Model.DescribeStorediSCSIVolumesRequest)"> <summary> This operation returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStorediSCSIVolumes service method.</param> <returns>The response from the DescribeStorediSCSIVolumes service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeStorediSCSIVolumesAsync(Amazon.StorageGateway.Model.DescribeStorediSCSIVolumesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeStorediSCSIVolumes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStorediSCSIVolumes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeTapeArchives"> <summary> Returns a description of specified virtual tapes in the virtual tape shelf (VTS). <para> If a specific <code>TapeARN</code> is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account. </para> </summary> <returns>The response from the DescribeTapeArchives service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeTapeArchives(Amazon.StorageGateway.Model.DescribeTapeArchivesRequest)"> <summary> Returns a description of specified virtual tapes in the virtual tape shelf (VTS). <para> If a specific <code>TapeARN</code> is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTapeArchives service method.</param> <returns>The response from the DescribeTapeArchives service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeTapeArchivesAsync(Amazon.StorageGateway.Model.DescribeTapeArchivesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTapeArchives operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTapeArchives operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeTapeRecoveryPoints(Amazon.StorageGateway.Model.DescribeTapeRecoveryPointsRequest)"> <summary> Returns a list of virtual tape recovery points that are available for the specified gateway-VTL. <para> A recovery point is a point in time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTapeRecoveryPoints service method.</param> <returns>The response from the DescribeTapeRecoveryPoints service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeTapeRecoveryPointsAsync(Amazon.StorageGateway.Model.DescribeTapeRecoveryPointsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTapeRecoveryPoints operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTapeRecoveryPoints operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeTapes(Amazon.StorageGateway.Model.DescribeTapesRequest)"> <summary> Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a <code>TapeARN</code> is not specified, returns a description of all virtual tapes associated with the specified gateway. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTapes service method.</param> <returns>The response from the DescribeTapes service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeTapesAsync(Amazon.StorageGateway.Model.DescribeTapesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeTapes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTapes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeUploadBuffer(Amazon.StorageGateway.Model.DescribeUploadBufferRequest)"> <summary> This operation returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures. <para> The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeUploadBuffer service method.</param> <returns>The response from the DescribeUploadBuffer service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeUploadBufferAsync(Amazon.StorageGateway.Model.DescribeUploadBufferRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeUploadBuffer operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeUploadBuffer operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeVTLDevices(Amazon.StorageGateway.Model.DescribeVTLDevicesRequest)"> <summary> Returns a description of virtual tape library (VTL) devices for the specified gateway. In the response, AWS Storage Gateway returns VTL device information. <para> The list of VTL devices must be from one gateway. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVTLDevices service method.</param> <returns>The response from the DescribeVTLDevices service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeVTLDevicesAsync(Amazon.StorageGateway.Model.DescribeVTLDevicesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeVTLDevices operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVTLDevices operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeWorkingStorage(Amazon.StorageGateway.Model.DescribeWorkingStorageRequest)"> <summary> This operation returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead. <note> <para> Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored-volume gateway. </para> </note> <para> The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkingStorage service method.</param> <returns>The response from the DescribeWorkingStorage service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DescribeWorkingStorageAsync(Amazon.StorageGateway.Model.DescribeWorkingStorageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeWorkingStorage operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkingStorage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DisableGateway(Amazon.StorageGateway.Model.DisableGatewayRequest)"> <summary> Disables a gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes. <para> Use this operation for a gateway-VTL that is not reachable or not functioning. </para> <important>Once a gateway is disabled it cannot be enabled.</important> </summary> <param name="request">Container for the necessary parameters to execute the DisableGateway service method.</param> <returns>The response from the DisableGateway service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.DisableGatewayAsync(Amazon.StorageGateway.Model.DisableGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DisableGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ListGateways"> <summary> This operation lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN). <para> By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response. </para> <para> If you have more gateways than are returned in a response-that is, the response returns only a truncated list of your gateways-the response contains a marker that you can specify in your next request to fetch the next page of gateways. </para> </summary> <returns>The response from the ListGateways service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ListGateways(Amazon.StorageGateway.Model.ListGatewaysRequest)"> <summary> This operation lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN). <para> By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response. </para> <para> If you have more gateways than are returned in a response-that is, the response returns only a truncated list of your gateways-the response contains a marker that you can specify in your next request to fetch the next page of gateways. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListGateways service method.</param> <returns>The response from the ListGateways service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ListGatewaysAsync(Amazon.StorageGateway.Model.ListGatewaysRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the ListGateways operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ListLocalDisks(Amazon.StorageGateway.Model.ListLocalDisksRequest)"> <summary> This operation returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request. <para> The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a <code>DiskStatus</code> field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted). </para> </summary> <param name="request">Container for the necessary parameters to execute the ListLocalDisks service method.</param> <returns>The response from the ListLocalDisks service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ListLocalDisksAsync(Amazon.StorageGateway.Model.ListLocalDisksRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListLocalDisks operation. </summary> <param name="request">Container for the necessary parameters to execute the ListLocalDisks operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ListTagsForResource(Amazon.StorageGateway.Model.ListTagsForResourceRequest)"> <summary> This operation lists the tags that have been added to the specified resource. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResource service method.</param> <returns>The response from the ListTagsForResource service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ListTagsForResourceAsync(Amazon.StorageGateway.Model.ListTagsForResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListTagsForResource operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTagsForResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ListVolumeInitiators(Amazon.StorageGateway.Model.ListVolumeInitiatorsRequest)"> <summary> This operation lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. </summary> <param name="request">Container for the necessary parameters to execute the ListVolumeInitiators service method.</param> <returns>The response from the ListVolumeInitiators service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ListVolumeInitiatorsAsync(Amazon.StorageGateway.Model.ListVolumeInitiatorsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListVolumeInitiators operation. </summary> <param name="request">Container for the necessary parameters to execute the ListVolumeInitiators operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ListVolumeRecoveryPoints(Amazon.StorageGateway.Model.ListVolumeRecoveryPointsRequest)"> <summary> This operation lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture. <para> Each gateway-cached volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To create a snapshot from a volume recovery point use the <a>CreateSnapshotFromVolumeRecoveryPoint</a> operation. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListVolumeRecoveryPoints service method.</param> <returns>The response from the ListVolumeRecoveryPoints service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ListVolumeRecoveryPointsAsync(Amazon.StorageGateway.Model.ListVolumeRecoveryPointsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListVolumeRecoveryPoints operation. </summary> <param name="request">Container for the necessary parameters to execute the ListVolumeRecoveryPoints operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ListVolumes(Amazon.StorageGateway.Model.ListVolumesRequest)"> <summary> This operation lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the <a>DescribeStorediSCSIVolumes</a> API. <para> The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the <code>Limit</code> field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListVolumes service method.</param> <returns>The response from the ListVolumes service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ListVolumesAsync(Amazon.StorageGateway.Model.ListVolumesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ListVolumes operation. </summary> <param name="request">Container for the necessary parameters to execute the ListVolumes operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.RemoveTagsFromResource(Amazon.StorageGateway.Model.RemoveTagsFromResourceRequest)"> <summary> This operation removes one or more tags from the specified resource. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromResource service method.</param> <returns>The response from the RemoveTagsFromResource service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.RemoveTagsFromResourceAsync(Amazon.StorageGateway.Model.RemoveTagsFromResourceRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RemoveTagsFromResource operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromResource operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ResetCache(System.String)"> <summary> This operation resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. <important> <para> If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly. </para> </important> </summary> <param name="gatewayARN">A property of ResetCacheRequest used to execute the ResetCache service method.</param> <returns>The response from the ResetCache service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ResetCache(Amazon.StorageGateway.Model.ResetCacheRequest)"> <summary> This operation resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. <important> <para> If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the ResetCache service method.</param> <returns>The response from the ResetCache service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ResetCacheAsync(Amazon.StorageGateway.Model.ResetCacheRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ResetCache operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetCache operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.RetrieveTapeArchive(Amazon.StorageGateway.Model.RetrieveTapeArchiveRequest)"> <summary> Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS. <para> Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. </para> </summary> <param name="request">Container for the necessary parameters to execute the RetrieveTapeArchive service method.</param> <returns>The response from the RetrieveTapeArchive service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.RetrieveTapeArchiveAsync(Amazon.StorageGateway.Model.RetrieveTapeArchiveRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RetrieveTapeArchive operation. </summary> <param name="request">Container for the necessary parameters to execute the RetrieveTapeArchive operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.RetrieveTapeRecoveryPoint(Amazon.StorageGateway.Model.RetrieveTapeRecoveryPointRequest)"> <summary> Retrieves the recovery point for the specified virtual tape. <para> A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. </para> <note>The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a gateway-VTL. There is no charge for retrieving recovery points.</note> </summary> <param name="request">Container for the necessary parameters to execute the RetrieveTapeRecoveryPoint service method.</param> <returns>The response from the RetrieveTapeRecoveryPoint service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.RetrieveTapeRecoveryPointAsync(Amazon.StorageGateway.Model.RetrieveTapeRecoveryPointRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RetrieveTapeRecoveryPoint operation. </summary> <param name="request">Container for the necessary parameters to execute the RetrieveTapeRecoveryPoint operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ShutdownGateway(Amazon.StorageGateway.Model.ShutdownGatewayRequest)"> <summary> This operation shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request. <para> The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM. </para> <note>If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.</note> <para> After the gateway is shutdown, you cannot call any other API except <a>StartGateway</a>, <a>DescribeGatewayInformation</a>, and <a>ListGateways</a>. For more information, see <a>ActivateGateway</a>. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken. </para> <note>When you make a shutdown request, you will get a <code>200 OK</code> success response immediately. However, it might take some time for the gateway to shut down. You can call the <a>DescribeGatewayInformation</a> API to check the status. For more information, see <a>ActivateGateway</a>.</note> <para> If do not intend to use the gateway again, you must delete the gateway (using <a>DeleteGateway</a>) to no longer pay software charges associated with the gateway. </para> </summary> <param name="request">Container for the necessary parameters to execute the ShutdownGateway service method.</param> <returns>The response from the ShutdownGateway service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.ShutdownGatewayAsync(Amazon.StorageGateway.Model.ShutdownGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the ShutdownGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the ShutdownGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.StartGateway(Amazon.StorageGateway.Model.StartGatewayRequest)"> <summary> This operation starts a gateway that you previously shut down (see <a>ShutdownGateway</a>). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups. <note>When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call <a>DescribeGatewayInformation</a> and check the status before making any additional API calls. For more information, see <a>ActivateGateway</a>.</note> <para> To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </summary> <param name="request">Container for the necessary parameters to execute the StartGateway service method.</param> <returns>The response from the StartGateway service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.StartGatewayAsync(Amazon.StorageGateway.Model.StartGatewayRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the StartGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the StartGateway operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.UpdateBandwidthRateLimit(Amazon.StorageGateway.Model.UpdateBandwidthRateLimitRequest)"> <summary> This operation updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. <para> By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth. </para> <para> To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateBandwidthRateLimit service method.</param> <returns>The response from the UpdateBandwidthRateLimit service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.UpdateBandwidthRateLimitAsync(Amazon.StorageGateway.Model.UpdateBandwidthRateLimitRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateBandwidthRateLimit operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateBandwidthRateLimit operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.UpdateChapCredentials(Amazon.StorageGateway.Model.UpdateChapCredentialsRequest)"> <summary> This operation updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. <important> <para> When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the UpdateChapCredentials service method.</param> <returns>The response from the UpdateChapCredentials service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.UpdateChapCredentialsAsync(Amazon.StorageGateway.Model.UpdateChapCredentialsRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateChapCredentials operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateChapCredentials operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.UpdateGatewayInformation(Amazon.StorageGateway.Model.UpdateGatewayInformationRequest)"> <summary> This operation updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. <note>For Gateways activated after September 02, 2015, the gateway's ARN contains the gateway id rather than the gateway name. However changing the name of the gateway has no effect on the gateway's ARN.</note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateGatewayInformation service method.</param> <returns>The response from the UpdateGatewayInformation service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.UpdateGatewayInformationAsync(Amazon.StorageGateway.Model.UpdateGatewayInformationRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateGatewayInformation operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateGatewayInformation operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.UpdateGatewaySoftwareNow(Amazon.StorageGateway.Model.UpdateGatewaySoftwareNowRequest)"> <summary> This operation updates the gateway virtual machine (VM) software. The request immediately triggers the software update. <note>When you make this request, you get a <code>200 OK</code> success response immediately. However, it might take some time for the update to complete. You can call <a>DescribeGatewayInformation</a> to verify the gateway is in the <code>STATE_RUNNING</code> state.</note> <important>A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings">Customizing Your Windows iSCSI Settings</a> and <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings">Customizing Your Linux iSCSI Settings</a>, respectively.</important> </summary> <param name="request">Container for the necessary parameters to execute the UpdateGatewaySoftwareNow service method.</param> <returns>The response from the UpdateGatewaySoftwareNow service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.UpdateGatewaySoftwareNowAsync(Amazon.StorageGateway.Model.UpdateGatewaySoftwareNowRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateGatewaySoftwareNow operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateGatewaySoftwareNow operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.UpdateMaintenanceStartTime(Amazon.StorageGateway.Model.UpdateMaintenanceStartTimeRequest)"> <summary> This operation updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. </summary> <param name="request">Container for the necessary parameters to execute the UpdateMaintenanceStartTime service method.</param> <returns>The response from the UpdateMaintenanceStartTime service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.UpdateMaintenanceStartTimeAsync(Amazon.StorageGateway.Model.UpdateMaintenanceStartTimeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateMaintenanceStartTime operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateMaintenanceStartTime operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.UpdateSnapshotSchedule(Amazon.StorageGateway.Model.UpdateSnapshotScheduleRequest)"> <summary> This operation updates a snapshot schedule configured for a gateway volume. <para> The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume. </para> <para> In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateSnapshotSchedule service method.</param> <returns>The response from the UpdateSnapshotSchedule service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.UpdateSnapshotScheduleAsync(Amazon.StorageGateway.Model.UpdateSnapshotScheduleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateSnapshotSchedule operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateSnapshotSchedule operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.UpdateVTLDeviceType(Amazon.StorageGateway.Model.UpdateVTLDeviceTypeRequest)"> <summary> This operation updates the type of medium changer in a gateway-VTL. When you activate a gateway-VTL, you select a medium changer type for the gateway-VTL. This operation enables you to select a different type of medium changer after a gateway-VTL is activated. </summary> <param name="request">Container for the necessary parameters to execute the UpdateVTLDeviceType service method.</param> <returns>The response from the UpdateVTLDeviceType service method, as returned by StorageGateway.</returns> <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException"> An internal server error has occurred during the request. See the error and message fields for more information. </exception> <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException"> An exception occurred because an invalid gateway request was issued to the service. See the error and message fields for more information. </exception> </member> <member name="M:Amazon.StorageGateway.AmazonStorageGatewayClient.UpdateVTLDeviceTypeAsync(Amazon.StorageGateway.Model.UpdateVTLDeviceTypeRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the UpdateVTLDeviceType operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateVTLDeviceType operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.WorkSpaces.AmazonWorkSpacesClient"> <summary> Implementation for accessing WorkSpaces Amazon WorkSpaces Service <para> This is the <i>Amazon WorkSpaces API Reference</i>. This guide provides detailed information about Amazon WorkSpaces operations, data types, parameters, and errors. </para> </summary> </member> <member name="T:Amazon.WorkSpaces.IAmazonWorkSpaces"> <summary> Interface for accessing WorkSpaces Amazon WorkSpaces Service <para> This is the <i>Amazon WorkSpaces API Reference</i>. This guide provides detailed information about Amazon WorkSpaces operations, data types, parameters, and errors. </para> </summary> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.CreateWorkspaces(Amazon.WorkSpaces.Model.CreateWorkspacesRequest)"> <summary> Creates one or more WorkSpaces. <note> <para> This operation is asynchronous and returns before the WorkSpaces are created. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the CreateWorkspaces service method.</param> <returns>The response from the CreateWorkspaces service method, as returned by WorkSpaces.</returns> <exception cref="T:Amazon.WorkSpaces.Model.ResourceLimitExceededException"> Your resource limits have been exceeded. </exception> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.CreateWorkspacesAsync(Amazon.WorkSpaces.Model.CreateWorkspacesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateWorkspaces operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateWorkspaces operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.DescribeWorkspaceBundles"> <summary> Obtains information about the WorkSpace bundles that are available to your account in the specified region. <para> You can filter the results with either the <code>BundleIds</code> parameter, or the <code>Owner</code> parameter, but not both. </para> <para> This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. </para> </summary> <returns>The response from the DescribeWorkspaceBundles service method, as returned by WorkSpaces.</returns> <exception cref="T:Amazon.WorkSpaces.Model.InvalidParameterValuesException"> One or more parameter values are not valid. </exception> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.DescribeWorkspaceBundles(Amazon.WorkSpaces.Model.DescribeWorkspaceBundlesRequest)"> <summary> Obtains information about the WorkSpace bundles that are available to your account in the specified region. <para> You can filter the results with either the <code>BundleIds</code> parameter, or the <code>Owner</code> parameter, but not both. </para> <para> This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkspaceBundles service method.</param> <returns>The response from the DescribeWorkspaceBundles service method, as returned by WorkSpaces.</returns> <exception cref="T:Amazon.WorkSpaces.Model.InvalidParameterValuesException"> One or more parameter values are not valid. </exception> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.DescribeWorkspaceBundlesAsync(Amazon.WorkSpaces.Model.DescribeWorkspaceBundlesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeWorkspaceBundles operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkspaceBundles operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.DescribeWorkspaceDirectories"> <summary> Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account. <para> This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. </para> </summary> <returns>The response from the DescribeWorkspaceDirectories service method, as returned by WorkSpaces.</returns> <exception cref="T:Amazon.WorkSpaces.Model.InvalidParameterValuesException"> One or more parameter values are not valid. </exception> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.DescribeWorkspaceDirectories(Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesRequest)"> <summary> Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account. <para> This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkspaceDirectories service method.</param> <returns>The response from the DescribeWorkspaceDirectories service method, as returned by WorkSpaces.</returns> <exception cref="T:Amazon.WorkSpaces.Model.InvalidParameterValuesException"> One or more parameter values are not valid. </exception> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.DescribeWorkspaceDirectoriesAsync(Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeWorkspaceDirectories operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkspaceDirectories operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.DescribeWorkspaces"> <summary> Obtains information about the specified WorkSpaces. <para> Only one of the filter parameters, such as <code>BundleId</code>, <code>DirectoryId</code>, or <code>WorkspaceIds</code>, can be specified at a time. </para> <para> This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. </para> </summary> <returns>The response from the DescribeWorkspaces service method, as returned by WorkSpaces.</returns> <exception cref="T:Amazon.WorkSpaces.Model.InvalidParameterValuesException"> One or more parameter values are not valid. </exception> <exception cref="T:Amazon.WorkSpaces.Model.ResourceUnavailableException"> The specified resource is not available. </exception> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.DescribeWorkspaces(Amazon.WorkSpaces.Model.DescribeWorkspacesRequest)"> <summary> Obtains information about the specified WorkSpaces. <para> Only one of the filter parameters, such as <code>BundleId</code>, <code>DirectoryId</code>, or <code>WorkspaceIds</code>, can be specified at a time. </para> <para> This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkspaces service method.</param> <returns>The response from the DescribeWorkspaces service method, as returned by WorkSpaces.</returns> <exception cref="T:Amazon.WorkSpaces.Model.InvalidParameterValuesException"> One or more parameter values are not valid. </exception> <exception cref="T:Amazon.WorkSpaces.Model.ResourceUnavailableException"> The specified resource is not available. </exception> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.DescribeWorkspacesAsync(Amazon.WorkSpaces.Model.DescribeWorkspacesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeWorkspaces operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkspaces operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.RebootWorkspaces(Amazon.WorkSpaces.Model.RebootWorkspacesRequest)"> <summary> Reboots the specified WorkSpaces. <para> To be able to reboot a WorkSpace, the WorkSpace must have a <b>State</b> of <code>AVAILABLE</code>, <code>IMPAIRED</code>, or <code>INOPERABLE</code>. </para> <note> <para> This operation is asynchronous and will return before the WorkSpaces have rebooted. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the RebootWorkspaces service method.</param> <returns>The response from the RebootWorkspaces service method, as returned by WorkSpaces.</returns> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.RebootWorkspacesAsync(Amazon.WorkSpaces.Model.RebootWorkspacesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RebootWorkspaces operation. </summary> <param name="request">Container for the necessary parameters to execute the RebootWorkspaces operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.RebuildWorkspaces(Amazon.WorkSpaces.Model.RebuildWorkspacesRequest)"> <summary> Rebuilds the specified WorkSpaces. <para> Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur: </para> <ul> <li>The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost.</li> <li>The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old.</li> </ul> <para> To be able to rebuild a WorkSpace, the WorkSpace must have a <b>State</b> of <code>AVAILABLE</code> or <code>ERROR</code>. </para> <note> <para> This operation is asynchronous and will return before the WorkSpaces have been completely rebuilt. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the RebuildWorkspaces service method.</param> <returns>The response from the RebuildWorkspaces service method, as returned by WorkSpaces.</returns> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.RebuildWorkspacesAsync(Amazon.WorkSpaces.Model.RebuildWorkspacesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RebuildWorkspaces operation. </summary> <param name="request">Container for the necessary parameters to execute the RebuildWorkspaces operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.TerminateWorkspaces(Amazon.WorkSpaces.Model.TerminateWorkspacesRequest)"> <summary> Terminates the specified WorkSpaces. <para> Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace. </para> <para> You can terminate a WorkSpace that is in any state except <code>SUSPENDED</code>. </para> <note> <para> This operation is asynchronous and will return before the WorkSpaces have been completely terminated. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the TerminateWorkspaces service method.</param> <returns>The response from the TerminateWorkspaces service method, as returned by WorkSpaces.</returns> </member> <member name="M:Amazon.WorkSpaces.IAmazonWorkSpaces.TerminateWorkspacesAsync(Amazon.WorkSpaces.Model.TerminateWorkspacesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TerminateWorkspaces operation. </summary> <param name="request">Container for the necessary parameters to execute the TerminateWorkspaces operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.#ctor"> <summary> Constructs AmazonWorkSpacesClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonWorkSpacesClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.#ctor(Amazon.WorkSpaces.AmazonWorkSpacesConfig)"> <summary> Constructs AmazonWorkSpacesClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonWorkSpacesClient Configuration Object</param> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonWorkSpacesClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonWorkSpacesClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.WorkSpaces.AmazonWorkSpacesConfig)"> <summary> Constructs AmazonWorkSpacesClient with AWS Credentials and an AmazonWorkSpacesClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonWorkSpacesClient Configuration Object</param> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.#ctor(System.String,System.String,Amazon.WorkSpaces.AmazonWorkSpacesConfig)"> <summary> Constructs AmazonWorkSpacesClient with AWS Access Key ID, AWS Secret Key and an AmazonWorkSpacesClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonWorkSpacesClient Configuration Object</param> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonWorkSpacesClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.#ctor(System.String,System.String,System.String,Amazon.WorkSpaces.AmazonWorkSpacesConfig)"> <summary> Constructs AmazonWorkSpacesClient with AWS Access Key ID, AWS Secret Key and an AmazonWorkSpacesClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonWorkSpacesClient Configuration Object</param> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.CreateWorkspaces(Amazon.WorkSpaces.Model.CreateWorkspacesRequest)"> <summary> Creates one or more WorkSpaces. <note> <para> This operation is asynchronous and returns before the WorkSpaces are created. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the CreateWorkspaces service method.</param> <returns>The response from the CreateWorkspaces service method, as returned by WorkSpaces.</returns> <exception cref="T:Amazon.WorkSpaces.Model.ResourceLimitExceededException"> Your resource limits have been exceeded. </exception> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.CreateWorkspacesAsync(Amazon.WorkSpaces.Model.CreateWorkspacesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the CreateWorkspaces operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateWorkspaces operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.DescribeWorkspaceBundles"> <summary> Obtains information about the WorkSpace bundles that are available to your account in the specified region. <para> You can filter the results with either the <code>BundleIds</code> parameter, or the <code>Owner</code> parameter, but not both. </para> <para> This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. </para> </summary> <returns>The response from the DescribeWorkspaceBundles service method, as returned by WorkSpaces.</returns> <exception cref="T:Amazon.WorkSpaces.Model.InvalidParameterValuesException"> One or more parameter values are not valid. </exception> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.DescribeWorkspaceBundles(Amazon.WorkSpaces.Model.DescribeWorkspaceBundlesRequest)"> <summary> Obtains information about the WorkSpace bundles that are available to your account in the specified region. <para> You can filter the results with either the <code>BundleIds</code> parameter, or the <code>Owner</code> parameter, but not both. </para> <para> This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkspaceBundles service method.</param> <returns>The response from the DescribeWorkspaceBundles service method, as returned by WorkSpaces.</returns> <exception cref="T:Amazon.WorkSpaces.Model.InvalidParameterValuesException"> One or more parameter values are not valid. </exception> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.DescribeWorkspaceBundlesAsync(Amazon.WorkSpaces.Model.DescribeWorkspaceBundlesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeWorkspaceBundles operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkspaceBundles operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.DescribeWorkspaceDirectories"> <summary> Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account. <para> This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. </para> </summary> <returns>The response from the DescribeWorkspaceDirectories service method, as returned by WorkSpaces.</returns> <exception cref="T:Amazon.WorkSpaces.Model.InvalidParameterValuesException"> One or more parameter values are not valid. </exception> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.DescribeWorkspaceDirectories(Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesRequest)"> <summary> Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account. <para> This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkspaceDirectories service method.</param> <returns>The response from the DescribeWorkspaceDirectories service method, as returned by WorkSpaces.</returns> <exception cref="T:Amazon.WorkSpaces.Model.InvalidParameterValuesException"> One or more parameter values are not valid. </exception> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.DescribeWorkspaceDirectoriesAsync(Amazon.WorkSpaces.Model.DescribeWorkspaceDirectoriesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeWorkspaceDirectories operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkspaceDirectories operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.DescribeWorkspaces"> <summary> Obtains information about the specified WorkSpaces. <para> Only one of the filter parameters, such as <code>BundleId</code>, <code>DirectoryId</code>, or <code>WorkspaceIds</code>, can be specified at a time. </para> <para> This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. </para> </summary> <returns>The response from the DescribeWorkspaces service method, as returned by WorkSpaces.</returns> <exception cref="T:Amazon.WorkSpaces.Model.InvalidParameterValuesException"> One or more parameter values are not valid. </exception> <exception cref="T:Amazon.WorkSpaces.Model.ResourceUnavailableException"> The specified resource is not available. </exception> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.DescribeWorkspaces(Amazon.WorkSpaces.Model.DescribeWorkspacesRequest)"> <summary> Obtains information about the specified WorkSpaces. <para> Only one of the filter parameters, such as <code>BundleId</code>, <code>DirectoryId</code>, or <code>WorkspaceIds</code>, can be specified at a time. </para> <para> This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkspaces service method.</param> <returns>The response from the DescribeWorkspaces service method, as returned by WorkSpaces.</returns> <exception cref="T:Amazon.WorkSpaces.Model.InvalidParameterValuesException"> One or more parameter values are not valid. </exception> <exception cref="T:Amazon.WorkSpaces.Model.ResourceUnavailableException"> The specified resource is not available. </exception> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.DescribeWorkspacesAsync(Amazon.WorkSpaces.Model.DescribeWorkspacesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DescribeWorkspaces operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeWorkspaces operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.RebootWorkspaces(Amazon.WorkSpaces.Model.RebootWorkspacesRequest)"> <summary> Reboots the specified WorkSpaces. <para> To be able to reboot a WorkSpace, the WorkSpace must have a <b>State</b> of <code>AVAILABLE</code>, <code>IMPAIRED</code>, or <code>INOPERABLE</code>. </para> <note> <para> This operation is asynchronous and will return before the WorkSpaces have rebooted. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the RebootWorkspaces service method.</param> <returns>The response from the RebootWorkspaces service method, as returned by WorkSpaces.</returns> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.RebootWorkspacesAsync(Amazon.WorkSpaces.Model.RebootWorkspacesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RebootWorkspaces operation. </summary> <param name="request">Container for the necessary parameters to execute the RebootWorkspaces operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.RebuildWorkspaces(Amazon.WorkSpaces.Model.RebuildWorkspacesRequest)"> <summary> Rebuilds the specified WorkSpaces. <para> Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur: </para> <ul> <li>The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost.</li> <li>The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old.</li> </ul> <para> To be able to rebuild a WorkSpace, the WorkSpace must have a <b>State</b> of <code>AVAILABLE</code> or <code>ERROR</code>. </para> <note> <para> This operation is asynchronous and will return before the WorkSpaces have been completely rebuilt. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the RebuildWorkspaces service method.</param> <returns>The response from the RebuildWorkspaces service method, as returned by WorkSpaces.</returns> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.RebuildWorkspacesAsync(Amazon.WorkSpaces.Model.RebuildWorkspacesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the RebuildWorkspaces operation. </summary> <param name="request">Container for the necessary parameters to execute the RebuildWorkspaces operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.TerminateWorkspaces(Amazon.WorkSpaces.Model.TerminateWorkspacesRequest)"> <summary> Terminates the specified WorkSpaces. <para> Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace. </para> <para> You can terminate a WorkSpace that is in any state except <code>SUSPENDED</code>. </para> <note> <para> This operation is asynchronous and will return before the WorkSpaces have been completely terminated. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the TerminateWorkspaces service method.</param> <returns>The response from the TerminateWorkspaces service method, as returned by WorkSpaces.</returns> </member> <member name="M:Amazon.WorkSpaces.AmazonWorkSpacesClient.TerminateWorkspacesAsync(Amazon.WorkSpaces.Model.TerminateWorkspacesRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the TerminateWorkspaces operation. </summary> <param name="request">Container for the necessary parameters to execute the TerminateWorkspaces operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> </member> <member name="T:Amazon.AWSClientFactory"> <summary> The Amazon Web Services SDK provides developers with a coherent and unified interface to the suite of Amazon Web Services. The intent is to facilitate the rapid building of applications that leverage multiple Amazon Web Services. <para> To get started, request an instance of the AWSClientFactory via this class's static Instance member. Use the factory instance to create clients for all the Web Services needed by the application.</para> </summary> </member> <member name="M:Amazon.AWSClientFactory.CreateAmazonAutoScalingClient"> <summary> Create a client for the Amazon AutoScaling Service with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <returns>An Amazon AutoScaling client</returns> <remarks> </remarks> </member> <member name="M:Amazon.AWSClientFactory.CreateAmazonAutoScalingClient(Amazon.AutoScaling.AmazonAutoScalingConfig)"> <summary> Create a client for the Amazon AutoScaling Service with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">Configuration options for the service like HTTP Proxy, # of connections, etc</param> <returns>An Amazon AutoScaling client</returns> </member> <member name="M:Amazon.AWSClientFactory.CreateAmazonAutoScalingClient(System.String,System.String)"> <summary> Create a client for the Amazon AutoScaling Service with the default configuration </summary> <param name="awsAccessKey">The AWS Access Key associated with the account</param> <param name="awsSecretAccessKey">The AWS Secret Access Key associated with the account</param> <returns>An Amazon AutoScaling client</returns> <remarks> </remarks> </member> <member name="M:Amazon.AWSClientFactory.CreateAmazonAutoScalingClient(System.String,System.String,Amazon.AutoScaling.AmazonAutoScalingConfig)"> <summary> Create a client for the Amazon AutoScaling Service with the specified configuration </summary> <param name="awsAccessKey">The AWS Access Key associated with the account</param> <param name="awsSecretAccessKey">The AWS Secret Access Key associated with the account</param> <param name="config">Configuration options for the service like HTTP Proxy, # of connections, etc </param> <returns>An Amazon AutoScaling client</returns> <remarks> </remarks> </member> <member name="M:Amazon.AWSClientFactory.CreateAmazonAutoScalingClient(Amazon.RegionEndpoint)"> <summary> Create a client for the Amazon AutoScaling Service with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect to.</param> <returns>An Amazon AutoScaling client</returns> </member> <member name="M:Amazon.AWSClientFactory.CreateAmazonAutoScalingClient(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Create a client for the Amazon AutoScaling Service with the specified region </summary> <param name="awsAccessKey">The AWS Access Key associated with the account</param> <param name="awsSecretAccessKey">The AWS Secret Access Key associated with the account</param> <param name="region">The region to connect to.</param> <returns>An Amazon AutoScaling client</returns> <remarks> </remarks> </member> <member name="M:Amazon.AWSClientFactory.CreateAmazonAutoScalingClient(Amazon.Runtime.AWSCredentials)"> <summary> Create a client for the Amazon AutoScaling Service with AWSCredentials. </summary> <param name="credentials">AWS Credentials</param> <returns>An Amazon AutoScaling client</returns> <remarks> </remarks> </member> <member name="M:Amazon.AWSClientFactory.CreateAmazonAutoScalingClient(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Create a client for the Amazon AutoScaling Service with AWSCredentials and region. </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect to.</param> <returns>An Amazon AutoScaling client</returns> <remarks> </remarks> </member> <member name="M:Amazon.AWSClientFactory.CreateAmazonAutoScalingClient(Amazon.Runtime.AWSCredentials,Amazon.AutoScaling.AmazonAutoScalingConfig)"> <summary> Create a client for the Amazon AutoScaling Service with AWSCredentials and an AmazonAutoScaling Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="config">Configuration options for the service like HTTP Proxy, # of connections, etc</param> <returns>An Amazon AutoScaling client</returns> <remarks> </remarks> </member> <member name="M:Amazon.AWSClientFactory.CreateAmazonCloudFormationClient"> <summary> Create a client for the Amazon CloudFormation Service with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <returns>An Amazon CloudFormation client</returns> <remarks> </remarks> </member> <member name="M:Amazon.AWSClientFactory.CreateAmazonCloudFormationClient(Amazon.CloudFormation.AmazonCloudFormationConfig)"> <summary> Create a client for the Amazon CloudFormation Service with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">Configuration options for the service like HTTP Proxy, # of connections, etc</param> <returns>An Amazon CloudFormation client</returns> </member> <member name="M:Amazon.AWSClientFactory.CreateAmazonCloudFormationClient(System.String,System.String)"> <summary> Create a client for the Amazon CloudFormation Service with the default configuration </summary> <param name="awsAccessKey">The AWS Access Key associated with the account</param> <param name="awsSecretAccessKey">The AWS Secret Access Key associated with the account</param> <returns>An Amazon CloudFormation client</returns> <remarks> </remarks> </member> <member name="M:Amazon.AWSClientFactory.CreateAmazonCloudFormationClient(System.String,System.String,Amazon.CloudFormation.AmazonCloudFormationConfig)"> <summary> Create a client for the Amazon CloudFormation Service with the specified configuration </summary> <param name="awsAccessKey">The AWS Access Key associated with the account</param> <param name="awsSecretAccessKey">The AWS Secret Access Key associated with the account</param> <param name="config">Configuration options for the service like HTTP Proxy, # of connections, etc </param> <returns>An Amazon CloudFormation client</returns> <remarks> </remarks> </member> <member name="M:Amazon.AWSClientFactory.CreateAmazonCloudFormationClient(Amazon.RegionEndpoint)"> <summary> Create a client for the Amazon CloudFormation Service with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect to.</param> <returns>An Amazon CloudFormation client</returns> </member> <member name="M:Amazon.AWSClientFactory.CreateAmazonCloudFormationClient(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Create a client for the Amazon CloudFormation Service with the specified region </summary> <param name="awsAccessKey">The AWS Access Key associated with the account</param> <param name="awsSecretAccessKey">The AWS Secret Access Key associated with the account</param> <param name="region">The region to connect to.</param> <returns>An Amazon CloudFormation client</returns> <remarks> </remarks> </member> <member name="M:Amazon.AWSClientFactory.CreateAmazonCloudFormationClient(Amazon.Runtime.AWSCredentials)"> <summary> Create a client for the Amazon CloudFormation Service with AWSCredentials. </summary> <param name="credentials">AWS Credentials</param> <returns>An Amazon CloudFormation client</returns> <remarks> </remarks> </member> <member name="